diff options
Diffstat (limited to 'doc/man/man3/qnpwidget.3qt')
| -rw-r--r-- | doc/man/man3/qnpwidget.3qt | 129 |
1 files changed, 129 insertions, 0 deletions
diff --git a/doc/man/man3/qnpwidget.3qt b/doc/man/man3/qnpwidget.3qt new file mode 100644 index 000000000..40ad33baf --- /dev/null +++ b/doc/man/man3/qnpwidget.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 <qnp.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 retquired. 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). |