diff options
Diffstat (limited to 'doc/man/man3/tqclipboard.3qt')
| -rw-r--r-- | doc/man/man3/tqclipboard.3qt | 138 |
1 files changed, 69 insertions, 69 deletions
diff --git a/doc/man/man3/tqclipboard.3qt b/doc/man/man3/tqclipboard.3qt index fba1aacf7..fac76e43f 100644 --- a/doc/man/man3/tqclipboard.3qt +++ b/doc/man/man3/tqclipboard.3qt @@ -1,5 +1,5 @@ '\" t -.TH QClipboard 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQClipboard 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,9 +7,9 @@ .ad l .nh .SH NAME -QClipboard \- Access to the window system clipboard +TQClipboard \- Access to the window system clipboard .SH SYNOPSIS -\fC#include <ntqclipboard.h>\fR +\fC#include <tqclipboard.h>\fR .PP Inherits TQObject. .PP @@ -104,24 +104,24 @@ Inherits TQObject. .br .in -1c .SH DESCRIPTION -The QClipboard class provides access to the window system clipboard. +The TQClipboard 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 TQDragObject does, and uses similar mechanisms. For advanced clipboard usage read the drag-and-drop documentation. +TQClipboard supports the same data types that TQDragObject 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(). +There is a single TQClipboard object in an application, and you can access it using QApplication::clipboard(). .PP Example: .PP .nf .br - QClipboard *cb = QApplication::clipboard(); + TQClipboard *cb = QApplication::clipboard(); .br .br // Copy text from the clipboard (paste) .br - TQString text = cb->text(QClipboard::Clipboard); + TQString text = cb->text(TQClipboard::Clipboard); .br if ( !text.isNull() ) .br @@ -132,11 +132,11 @@ Example: .br cb->setText( "This text can be pasted by other programs", .br - QClipboard::Clipboard ); + TQClipboard::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 TQImages between applications. The setData() function is the ultimate in flexibility: it allows you to add any TQMimeSource into the clipboard. There are corresponding getters for each of these, e.g. text(), image() and pixmap(). +TQClipboard 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 TQImages between applications. The setData() function is the ultimate in flexibility: it allows you to add any TQMimeSource 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" @@ -165,93 +165,93 @@ See the multiclip example in the \fIQt Designer\fR examples directory for an exa .PP See also Environment Classes and Input/Output and Networking. .SS "Member Type Documentation" -.SH "QClipboard::Mode" +.SH "TQClipboard::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. +This enum type is used to control which part of the system clipboard is used by TQClipboard::data(), TQClipboard::setData() and related functions. .TP -\fCQClipboard::Clipboard\fR - indicates that data should be stored and retrieved from the global clipboard. +\fCTQClipboard::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. +\fCTQClipboard::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(). +See also TQClipboard::supportsSelection(). .SH MEMBER FUNCTION DOCUMENTATION -.SH "void QClipboard::clear ( Mode mode )" +.SH "void TQClipboard::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. +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is TQClipboard::Clipboard, this function clears the the global clipboard contents. If \fImode\fR is TQClipboard::Selection, this function clears the global mouse selection contents. .PP -See also QClipboard::Mode and supportsSelection(). -.SH "void QClipboard::clear ()" +See also TQClipboard::Mode and supportsSelection(). +.SH "void TQClipboard::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 "TQMimeSource * QClipboard::data ( Mode mode ) const" +This function uses the TQClipboard::clear() function which takes a TQClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is TQClipboard::Selection, otherwise the mode argument is TQClipboard::Clipboard. +.SH "TQMimeSource * TQClipboard::data ( Mode mode ) const" Returns a reference to a TQMimeSource 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. +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is TQClipboard::Clipboard, the data is retrieved from the global clipboard. If \fImode\fR is TQClipboard::Selection, the data is retrieved from the global mouse selection. .PP See also setData(). -.SH "TQMimeSource * QClipboard::data () const" +.SH "TQMimeSource * TQClipboard::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 function uses the TQClipboard::data() function which takes a TQClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is TQClipboard::Selection, otherwise the mode argument is TQClipboard::Clipboard. +.SH "void TQClipboard::dataChanged ()\fC [signal]\fR" This signal is emitted when the clipboard data is changed. -.SH "TQImage QClipboard::image ( Mode mode ) const" +.SH "TQImage TQClipboard::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. +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is TQClipboard::Clipboard, the image is retrieved from the global clipboard. If \fImode\fR is TQClipboard::Selection, the image is retrieved from the global mouse selection. .PP See also setImage(), pixmap(), data(), and TQImage::isNull(). -.SH "TQImage QClipboard::image () const" +.SH "TQImage TQClipboard::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" +This function uses the TQClipboard::image() function which takes a TQClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is TQClipboard::Selection, otherwise the mode argument is TQClipboard::Clipboard. +.SH "bool TQClipboard::ownsClipboard () const" Returns TRUE if this clipboard object owns the clipboard data; otherwise returns FALSE. -.SH "bool QClipboard::ownsSelection () const" +.SH "bool TQClipboard::ownsSelection () const" Returns TRUE if this clipboard object owns the mouse selection data; otherwise returns FALSE. -.SH "QPixmap QClipboard::pixmap ( Mode mode ) const" +.SH "QPixmap TQClipboard::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. +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is TQClipboard::Clipboard, the pixmap is retrieved from the global clipboard. If \fImode\fR is TQClipboard::Selection, the pixmap is retrieved from the global mouse selection. .PP See also setPixmap(), image(), data(), and QPixmap::convertFromImage(). -.SH "QPixmap QClipboard::pixmap () const" +.SH "QPixmap TQClipboard::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 function uses the TQClipboard::pixmap() function which takes a TQClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is TQClipboard::Selection, otherwise the mode argument is TQClipboard::Clipboard. +.SH "void TQClipboard::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" +.SH "bool TQClipboard::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. +Use the TQClipboard::data(), TQClipboard::setData() and related functions which take a TQClipboard::Mode argument. .PP Returns the selection mode. .PP See also setSelectionMode() and supportsSelection(). -.SH "void QClipboard::setData ( TQMimeSource * src, Mode mode )" +.SH "void TQClipboard::setData ( TQMimeSource * 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. +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is TQClipboard::Clipboard, the data is retrieved from the global clipboard. If \fImode\fR is TQClipboard::Selection, the data is retrieved from the global mouse selection. .PP The TQDragObject subclasses are reasonable objects to put into the clipboard (but do not try to call TQDragObject::drag() on the same object). Any TQDragObject placed in the clipboard should have a parent of 0. Do not put TQDragMoveEvent or TQDropEvent 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 ( TQMimeSource * src )" +.SH "void TQClipboard::setData ( TQMimeSource * 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 TQImage & image, Mode mode )" +This function uses the TQClipboard::setData() function which takes a TQClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is TQClipboard::Selection, otherwise the mode argument is TQClipboard::Clipboard. +.SH "void TQClipboard::setImage ( const TQImage & 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. +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is TQClipboard::Clipboard, the image is stored in the global clipboard. If \fImode\fR is TQClipboard::Selection, the data is stored in the global mouse selection. .PP This is shorthand for: .PP @@ -262,77 +262,77 @@ This is shorthand for: .fi .PP See also image(), setPixmap(), and setData(). -.SH "void QClipboard::setImage ( const TQImage & image )" +.SH "void TQClipboard::setImage ( const TQImage & 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 )" +This function uses the TQClipboard::setImage() function which takes a TQClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is TQClipboard::Selection, otherwise the mode argument is TQClipboard::Clipboard. +.SH "void TQClipboard::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 TQImage 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. +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is TQClipboard::Clipboard, the pixmap is stored in the global clipboard. If \fImode\fR is TQClipboard::Selection, the pixmap is stored in the global mouse selection. .PP See also pixmap(), setImage(), and setData(). -.SH "void QClipboard::setPixmap ( const QPixmap & pixmap )" +.SH "void TQClipboard::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 )" +This function uses the TQClipboard::setPixmap() function which takes a TQClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is TQClipboard::Selection, otherwise the mode argument is TQClipboard::Clipboard. +.SH "void TQClipboard::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. +Use the TQClipboard::data(), TQClipboard::setData() and related functions which take a TQClipboard::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. +Sets the clipboard selection mode. If \fIenable\fR is TRUE, then subsequent calls to TQClipboard::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 TQString & text, Mode mode )" +.SH "void TQClipboard::setText ( const TQString & 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. +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is TQClipboard::Clipboard, the text is stored in the global clipboard. If \fImode\fR is TQClipboard::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 TQString & text )" +.SH "void TQClipboard::setText ( const TQString & 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" +This function uses the TQClipboard::setText() function which takes a TQClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is TQClipboard::Selection, otherwise the mode argument is TQClipboard::Clipboard. +.SH "bool TQClipboard::supportsSelection () const" Returns TRUE if the clipboard supports mouse selection; otherwise returns FALSE. .PP Example: regexptester/regexptester.cpp. -.SH "TQString QClipboard::text ( Mode mode ) const" +.SH "TQString TQClipboard::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. +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is TQClipboard::Clipboard, the text is retrieved from the global clipboard. If \fImode\fR is TQClipboard::Selection, the text is retrieved from the global mouse selection. .PP See also setText(), data(), and TQString::operator!(). -.SH "TQString QClipboard::text ( TQCString & subtype, Mode mode ) const" +.SH "TQString TQClipboard::text ( TQCString & 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. +The \fImode\fR argument is used to control which part of the system clipboard is used. If \fImode\fR is TQClipboard::Clipboard, the text is retrieved from the global clipboard. If \fImode\fR is TQClipboard::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 TQString::operator!(). -.SH "TQString QClipboard::text () const" +.SH "TQString TQClipboard::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 "TQString QClipboard::text ( TQCString & subtype ) const" +This function uses the TQClipboard::text() function which takes a TQClipboard::Mode argument. The value of the mode argument is determined by the return value of selectionModeEnabled(). If selectionModeEnabled() returns TRUE, the mode argument is TQClipboard::Selection, otherwise the mode argument is TQClipboard::Clipboard. +.SH "TQString TQClipboard::text ( TQCString & 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 +TQClipboard::text() function which takes a TQClipboard::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. +returns TRUE, the mode argument is TQClipboard::Selection, +otherwise the mode argument is TQClipboard::Clipboard. .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqclipboard.html +.BR http://doc.trolltech.com/tqclipboard.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |