[Kde-cygwin-cvs] CVS: qt-3/doc/man/man3 qnpinstance.3qt,1.1,1.2 qnplugin.3qt,1.1,1.2 qnpstream.3qt,1
Status: Inactive
Brought to you by:
habacker
Menu
▾
▴
[Kde-cygwin-cvs] CVS: qt-3/doc/man/man3 qnpinstance.3qt,1.1,1.2 qnplugin.3qt,1.1,1.2 qnpstream.3qt,1.1,1.2 qnpwidget.3qt,1.1,1.2
|
From: Christian E. <che...@us...> - 2005-09-23 09:41:21
|
Update of /cvsroot/kde-cygwin/qt-3/doc/man/man3 In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv26950/doc/man/man3 Modified Files: qnpinstance.3qt qnplugin.3qt qnpstream.3qt qnpwidget.3qt Log Message: st qt3.3.5 patch - I made the smae mistake like 3.3.4 but don't know what is going wrong there. Seems like our cvs is messed up :( ttt: ---------------------------------------------------------------------- Index: qnpinstance.3qt =================================================================== RCS file: /cvsroot/kde-cygwin/qt-3/doc/man/man3/qnpinstance.3qt,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- qnpinstance.3qt 22 Jun 2002 21:16:13 -0000 1.1 +++ qnpinstance.3qt 23 Sep 2005 09:40:27 -0000 1.2 @@ -1,5 +1,5 @@ '\" t -.TH QNPInstance 3qt "26 April 2002" "Trolltech AS" \" -*- nroff -*- +.TH QNPInstance 3qt "5 August 2004" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2001 Trolltech AS. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,116 +7,39 @@ .ad l .nh .SH NAME -QNPInstance \- QObject that is a Web-browser plugin +QNPInstance \- QObject that is a web browser plugin .SH SYNOPSIS +This class is part of the \fBQt Netscape Extension\fR. +.PP \fC#include <qnp.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 +<li class=fn>\fB~QNPInstance\fR () <li class=fn>int \fBargc\fR () const <li class=fn>const char * \fBargn\fR ( int i ) const <li class=fn>const char * \fBargv\fR ( int i ) const <li class=fn>enum \fBReason\fR { ReasonDone = 0, ReasonBreak = 1, ReasonError = 2, ReasonUnknown = -1 } <li class=fn>const char * \fBarg\fR ( const char * name ) const <li class=fn>enum \fBInstanceMode\fR { Embed = 1, Full = 2, Background = 3 } <li class=fn>InstanceMode \fBmode\fR () const <li class=fn>const char * \fBuserAgent\fR () const <li class=fn>virtual QNPWidget * \fBnewWindow\fR () <li class=fn>QNPWidget * \fBwidget\fR () <li class=fn>enum \fBStreamMode\fR { Normal = 1, Seek = 2, AsFile = 3, AsFileOnly = 4 } <li class=fn>virtual bool \fBnewStreamCreated\fR ( QNPStream *, StreamMode & smode ) <li class=fn>virtual int \fBwriteReady\fR ( QNPStream * ) <li class=fn>virtual int \fBwrite\fR ( QNPStream *, int offset, int len, void * buffer ) <li class=fn>virtual void \fBstreamDestroyed\fR ( QNPStream * ) <li class=fn>void \fBstatus\fR ( const char * msg ) <li class=fn>void \fBgetURLNotify\fR ( const char * url, const char * window = 0, void * data = 0 ) <li class=fn>void \fBgetURL\fR ( const char * url, const char * window = 0 ) <li class=fn>void \fBpostURL\fR ( const char * url, const char * window, uint len, const char * buf, bool file ) <li class=fn>QNPStream * \fBnewStream\fR ( const char * mimetype, const char * window, bool as_file = FALSE ) <li class=fn>virtual void \fBstreamAsFile\fR ( QNPStream *, const char * fname ) <li class=fn>void * \fBgetJavaPeer\fR () const <li class=fn>virtual void \fBnotifyURL\fR ( const char * url, Reason r, void * notifyData ) <li class=fn>virtual bool \fBprintFullPage\fR () <li class=fn>virtual void \fBprint\fR ( QPainter * ) .in -1c .SS "Protected Members" .in +1c -.ti -1c -.BI "\fBQNPInstance\fR ()" -.br +<li class=fn>\fBQNPInstance\fR () .in -1c .SH DESCRIPTION -This class is defined in the \fBQt NSPlugin Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +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. +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 window if required (not all plugins have windows), and for interacting with the input/output facilities intrinsic to plugins. +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 (ie. 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. +\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 -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, this restriction can easily be accommodated. +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 npapi.h: +This enum type provides Qt-style names for three #defines in \fCnpapi.h\fR: .TP \fCQNPInstance::Embed\fR - corresponds to NP_EMBED .TP @@ -143,27 +66,40 @@ \fCQNPInstance::AsFileOnly\fR .SH MEMBER FUNCTION DOCUMENTATION .SH "QNPInstance::QNPInstance ()\fC [protected]\fR" -Creates a QNPInstance. Can only be called from within a derived class created within QNPlugin::newInstance(). +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 disappear. +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 with 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: -.TP -\fC<EMBED ...>\fR -- arg("FOO") == 0 -.TP -\fC<EMBED FOO ...>\fR -- arg("FOO") == "" -.TP -\fC<EMBED FOO=BAR ...>\fR -- arg("FOO") == "BAR" +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 also note that the SGML specification does not permit multiple arguments with the same name. +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(). +See also arg() and argn(). .SH "const char * QNPInstance::argn ( int i ) const" -Returns the name of the \fIi\fR-th argument. See argc(). +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. See argc(). +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 plug-in instance, an object of the plug-in's Java class, or 0 if the plug-in does not have a Java class, Java is disabled, or an error occurred. +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 @@ -171,7 +107,7 @@ .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 )" -Print the instance full-page. By default, this returns FALSE, causing the browser to call the (embedded) print() function instead. 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. +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" @@ -181,11 +117,13 @@ .PP This function is \fInot tested\fR. .PP -Requests the creation of a new data stream \fIfrom\fR the plug-in. 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. +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 was returned by the most recent call to writeReady(). +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 @@ -195,7 +133,7 @@ .PP This function is \fInot tested\fR. .PP -Called whenever a \fIurl\fR is notified after call to NPN_GetURLNotify with \fInotifyData\fR. The reason is given in \fIr\fR. +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 @@ -219,7 +157,9 @@ .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. It is an encapsulation of the NPP_Print function of the Netscape Plugin API. +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" @@ -229,7 +169,7 @@ .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. +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 ()" @@ -268,4 +208,4 @@ If you find errors in this manual page, please report them to .BR qt...@tr... . Please include the name of the manual page (qnpinstance.3qt) and the Qt -version (3.0.4). +version (3.3.3). Index: qnplugin.3qt =================================================================== RCS file: /cvsroot/kde-cygwin/qt-3/doc/man/man3/qnplugin.3qt,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- qnplugin.3qt 22 Jun 2002 21:16:13 -0000 1.1 +++ qnplugin.3qt 23 Sep 2005 09:40:27 -0000 1.2 @@ -1,5 +1,5 @@ '\" t -.TH QNPlugin 3qt "26 April 2002" "Trolltech AS" \" -*- nroff -*- +.TH QNPlugin 3qt "5 August 2004" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2001 Trolltech AS. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,88 +7,57 @@ .ad l .nh .SH NAME -QNPlugin \- The plugin central factory +QNPlugin \- The main factory for plugin objects .SH SYNOPSIS +This class is part of the \fBQt Netscape Extension\fR. +.PP \fC#include <qnp.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 +<li class=fn>virtual \fB~QNPlugin\fR () <li class=fn>void \fBgetVersionInfo\fR ( int & plugin_major, int & plugin_minor, int & browser_major, int & browser_minor ) <li class=fn>virtual QNPInstance * \fBnewInstance\fR () = 0 <li class=fn>virtual const char * \fBgetMIMEDescription\fR () const = 0 <li class=fn>virtual const char * \fBgetPluginNameString\fR () const = 0 <li class=fn>virtual const char * \fBgetPluginDescriptionString\fR () const = 0 <li class=fn>virtual void * \fBgetJavaClass\fR () <li class=fn>virtual void \fBunuseJavaClass\fR () <li class=fn>void * \fBgetJavaEnv\fR () const .in -1c .SS "Static Public Members" .in +1c -.ti -1c -.BI "QNPlugin * \fBcreate\fR ()" -.br -.ti -1c -.BI "QNPlugin * \fBactual\fR ()" -.br +<li class=fn>QNPlugin * \fBcreate\fR () <li class=fn>QNPlugin * \fBactual\fR () .in -1c .SS "Protected Members" .in +1c -.ti -1c -.BI "\fBQNPlugin\fR ()" -.br +<li class=fn>\fBQNPlugin\fR () .in -1c .SH DESCRIPTION -This class is defined in the \fBQt NSPlugin Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +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 plugin central factory. +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 instances for a single running Web-browser process. +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! +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 derived class returned by plugin's implementation of the QNPlugin::create() function. +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 before the plugin is deleted. +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 returns by QNPlugin::create(). +Returns the plugin most recently returned by QNPlugin::create(). .SH "QNPlugin * QNPlugin::create ()\fC [static]\fR" -This must be implemented by your plugin code. It should return a derived class of QNPlugin. +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 to return a reference to the Java class that represents the plugin. The default returns 0, indicating no class. +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. +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 Java is disabled or an error occurred. +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. +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 to return the MIME description of the data formats supported by your plugin. The format of this string is shown by the following example: +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 @@ -117,17 +86,17 @@ } .fi .SH "const char * QNPlugin::getPluginDescriptionString () const\fC [pure virtual]\fR" -Returns the plain-text description of the plugin. +Returns a pointer to the plain-text description of the plugin. .SH "const char * QNPlugin::getPluginNameString () const\fC [pure virtual]\fR" -Returns the plain-text name of the plugin. +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 browser. +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 to return an appropriate derived class of QNPInstance. +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, -with jc set to the value returned earlier by getJavaClass(). -The function should \fIunuse\fR the Java class and return 0. +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 @@ -152,4 +121,4 @@ If you find errors in this manual page, please report them to .BR qt...@tr... . Please include the name of the manual page (qnplugin.3qt) and the Qt -version (3.0.4). +version (3.3.3). Index: qnpstream.3qt =================================================================== RCS file: /cvsroot/kde-cygwin/qt-3/doc/man/man3/qnpstream.3qt,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- qnpstream.3qt 22 Jun 2002 21:16:13 -0000 1.1 +++ qnpstream.3qt 23 Sep 2005 09:40:27 -0000 1.2 @@ -1,5 +1,5 @@ '\" t -.TH QNPStream 3qt "26 April 2002" "Trolltech AS" \" -*- nroff -*- +.TH QNPStream 3qt "5 August 2004" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2001 Trolltech AS. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -9,49 +9,16 @@ .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 <qnp.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 +<li class=fn>\fB~QNPStream\fR () <li class=fn>const char * \fBurl\fR () const <li class=fn>uint \fBend\fR () const <li class=fn>uint \fBlastModified\fR () const <li class=fn>const char * \fBtype\fR () const <li class=fn>bool \fBseekable\fR () const <li class=fn>bool \fBokay\fR () const <li class=fn>bool \fBcomplete\fR () const <li class=fn>void \fBrequestRead\fR ( int offset, uint length ) <li class=fn>int \fBwrite\fR ( int len, void * buffer ) <li class=fn>QNPInstance * \fBinstance\fR () <li class=fn>\fBQNPStream\fR ( QNPInstance * in, const char * mt, _NPStream * st, bool se ) .in -1c .SH DESCRIPTION -This class is defined in the \fBQt NSPlugin Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +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 @@ -60,15 +27,15 @@ 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, but rather QNPInstance::newStream() if a stream is required. +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. +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. Can be 0 for streams of unknown length. +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" @@ -109,4 +76,4 @@ If you find errors in this manual page, please report them to .BR qt...@tr... . Please include the name of the manual page (qnpstream.3qt) and the Qt -version (3.0.4). +version (3.3.3). Index: qnpwidget.3qt =================================================================== RCS file: /cvsroot/kde-cygwin/qt-3/doc/man/man3/qnpwidget.3qt,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- qnpwidget.3qt 22 Jun 2002 21:16:13 -0000 1.1 +++ qnpwidget.3qt 23 Sep 2005 09:40:27 -0000 1.2 @@ -1,5 +1,5 @@ '\" t -.TH QNPWidget 3qt "26 April 2002" "Trolltech AS" \" -*- nroff -*- +.TH QNPWidget 3qt "5 August 2004" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2001 Trolltech AS. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,42 +7,32 @@ .ad l .nh .SH NAME -QNPWidget \- QWidget that is a Web-browser plugin window +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 +<li class=fn>\fBQNPWidget\fR () <li class=fn>\fB~QNPWidget\fR () <li class=fn>virtual void \fBenterInstance\fR () <li class=fn>virtual void \fBleaveInstance\fR () <li class=fn>QNPInstance * \fBinstance\fR () .in -1c .SH DESCRIPTION -This class is defined in the \fBQt NSPlugin Extension\fR, which can be found in the \fCqt/extensions\fR directory. It is not included in the main Qt API. +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. +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 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. +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 { +class MyPluginWindow : public QNPWidget +.br +{ .br QWidget* child; .br @@ -87,13 +77,13 @@ .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. +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 window. +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 @@ -122,4 +112,4 @@ If you find errors in this manual page, please report them to .BR qt...@tr... . Please include the name of the manual page (qnpwidget.3qt) and the Qt -version (3.0.4). +version (3.3.3). |
