.TH "KJavaApplet" kde3 "11 Jun 2005" "Version Version 3.4.1" "khtml Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KJavaApplet \- A Java applet.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kjavaapplet.h>\fP
.PP
Inherits \fBQObject\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBAppletState\fP { \fBUNKNOWN\fP =  0, \fBCLASS_LOADED\fP =  1, \fBINSTANCIATED\fP =  2, \fBINITIALIZED\fP =  3, \fBSTARTED\fP =  4, \fBSTOPPED\fP =  5, \fBDESTROYED\fP =  6 }"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBjsEvent\fP (const \fBQStringList\fP &args)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKJavaApplet\fP (\fBKJavaAppletWidget\fP *_parent, \fBKJavaAppletContext\fP *_context=0)"
.br
.ti -1c
.RI "void \fBsetAppletContext\fP (\fBKJavaAppletContext\fP *_context)"
.br
.ti -1c
.RI "void \fBsetAppletClass\fP (const \fBQString\fP &clazzName)"
.br
.ti -1c
.RI "\fBQString\fP & \fBappletClass\fP ()"
.br
.ti -1c
.RI "void \fBsetBaseURL\fP (const \fBQString\fP &base)"
.br
.ti -1c
.RI "\fBQString\fP & \fBbaseURL\fP ()"
.br
.ti -1c
.RI "void \fBsetCodeBase\fP (const \fBQString\fP &codeBase)"
.br
.ti -1c
.RI "\fBQString\fP & \fBcodeBase\fP ()"
.br
.ti -1c
.RI "void \fBsetArchives\fP (const \fBQString\fP &_archives)"
.br
.ti -1c
.RI "\fBQString\fP & \fBarchives\fP ()"
.br
.ti -1c
.RI "void \fBsetAppletName\fP (const \fBQString\fP &\fBname\fP)"
.br
.ti -1c
.RI "\fBQString\fP & \fBappletName\fP ()"
.br
.ti -1c
.RI "void \fBsetSize\fP (\fBQSize\fP size)"
.br
.ti -1c
.RI "\fBQSize\fP \fBsize\fP ()"
.br
.ti -1c
.RI "void \fBsetParameter\fP (const \fBQString\fP &\fBname\fP, const \fBQString\fP &value)"
.br
.ti -1c
.RI "\fBQString\fP & \fBparameter\fP (const \fBQString\fP &\fBname\fP)"
.br
.ti -1c
.RI "\fBQMap\fP< \fBQString\fP, \fBQString\fP > & \fBgetParams\fP ()"
.br
.ti -1c
.RI "void \fBsetWindowName\fP (const \fBQString\fP &title)"
.br
.ti -1c
.RI "\fBQString\fP & \fBgetWindowName\fP ()"
.br
.ti -1c
.RI "void \fBresizeAppletWidget\fP (int width, int height)"
.br
.ti -1c
.RI "void \fBcreate\fP ()"
.br
.ti -1c
.RI "void \fBinit\fP ()"
.br
.ti -1c
.RI "bool \fBisCreated\fP ()"
.br
.ti -1c
.RI "void \fBstart\fP ()"
.br
.ti -1c
.RI "void \fBstop\fP ()"
.br
.ti -1c
.RI "int \fBappletId\fP ()"
.br
.ti -1c
.RI "void \fBsetAppletId\fP (int id)"
.br
.ti -1c
.RI "\fBKJavaAppletContext\fP * \fBgetContext\fP () const "
.br
.ti -1c
.RI "void \fBsetUser\fP (const \fBQString\fP &_user)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBuser\fP () const "
.br
.ti -1c
.RI "void \fBsetPassword\fP (const \fBQString\fP &_password)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBpassword\fP () const "
.br
.ti -1c
.RI "void \fBsetAuthName\fP (const \fBQString\fP &_auth)"
.br
.ti -1c
.RI "const \fBQString\fP & \fBauthName\fP () const "
.br
.ti -1c
.RI "void \fBstateChange\fP (const int newState)"
.br
.ti -1c
.RI "void \fBsetFailed\fP ()"
.br
.ti -1c
.RI "AppletState \fBstate\fP () const "
.br
.ti -1c
.RI "bool \fBfailed\fP () const "
.br
.ti -1c
.RI "bool \fBisAlive\fP () const "
.br
.ti -1c
.RI "void \fBjsData\fP (const \fBQStringList\fP &args)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A Java applet. 

This class encapsulates the data the Applet Server needs to load the Applet class files, and set the proper size of the Applet. It also has an interface for applets to resize themselves.
.PP
\fBAuthor:\fP
.RS 4
Richard J. Moore, rich@kde.org 
.PP
Wynn Wilkes, wynnw@kde.org 
.RE
.PP

.PP
Definition at line 50 of file kjavaapplet.h.
.SH "Member Function Documentation"
.PP 
.SS "void KJavaApplet::setAppletContext (\fBKJavaAppletContext\fP * _context)"
.PP
Set the applet context'. 
.PP
Definition at line 78 of file kjavaapplet.cpp.
.PP
References KJavaAppletContext::registerApplet().
.SS "void KJavaApplet::setAppletClass (const \fBQString\fP & clazzName)"
.PP
Specify the name of the class file to run. 
.PP
For example 'Lake.class'. 
.PP
Definition at line 84 of file kjavaapplet.cpp.
.PP
References QObject::className().
.SS "\fBQString\fP & KJavaApplet::appletClass ()"
.PP
Get the name of the Class file the applet should run. 
.PP
Definition at line 89 of file kjavaapplet.cpp.
.SS "void KJavaApplet::setBaseURL (const \fBQString\fP & base)"
.PP
Set the URL of the document embedding the applet. 
.PP
Definition at line 109 of file kjavaapplet.cpp.
.PP
References baseURL().
.SS "\fBQString\fP & KJavaApplet::baseURL ()"
.PP
get the Base URL of the document embedding the applet 
.PP
Definition at line 114 of file kjavaapplet.cpp.
.PP
Referenced by setBaseURL().
.SS "void KJavaApplet::setCodeBase (const \fBQString\fP & codeBase)"
.PP
Set the codebase of the applet classes. 
.PP
Definition at line 119 of file kjavaapplet.cpp.
.PP
References codeBase().
.SS "\fBQString\fP & KJavaApplet::codeBase ()"
.PP
Get the codebase of the applet classes. 
.PP
Definition at line 124 of file kjavaapplet.cpp.
.PP
Referenced by setCodeBase().
.SS "void KJavaApplet::setArchives (const \fBQString\fP & _archives)"
.PP
Set the list of archives at the Applet's codebase to search in for class files and other resources. 
.PP
Definition at line 139 of file kjavaapplet.cpp.
.SS "\fBQString\fP & KJavaApplet::archives ()"
.PP
Get the list of Archives that should be searched for class files and other resources. 
.PP
Definition at line 144 of file kjavaapplet.cpp.
.SS "void KJavaApplet::setAppletName (const \fBQString\fP & name)"
.PP
Set the name the applet should be called in its context. 
.PP
Definition at line 161 of file kjavaapplet.cpp.
.SS "\fBQString\fP & KJavaApplet::appletName ()"
.PP
Get the name the applet should be called in its context. 
.PP
Definition at line 176 of file kjavaapplet.cpp.
.PP
Referenced by stateChange().
.SS "void KJavaApplet::setSize (\fBQSize\fP size)"
.PP
Set the size of the applet. 
.PP
Definition at line 129 of file kjavaapplet.cpp.
.SS "\fBQSize\fP KJavaApplet::size ()"
.PP
Get the size of the applet. 
.PP
Definition at line 134 of file kjavaapplet.cpp.
.SS "void KJavaApplet::setParameter (const \fBQString\fP & name, const \fBQString\fP & value)"
.PP
Specify a parameter to be passed to the applet. 
.PP
Definition at line 99 of file kjavaapplet.cpp.
.PP
References QMap::insert().
.SS "\fBQString\fP & KJavaApplet::parameter (const \fBQString\fP & name)"
.PP
Look up the parameter value for the given Parameter. 
.PP
Returns QString::null if the name has not been set. 
.PP
Definition at line 94 of file kjavaapplet.cpp.
.SS "\fBQMap\fP< \fBQString\fP, \fBQString\fP > & KJavaApplet::getParams ()"
.PP
Get a reference to the Paramaters and their values. 
.PP
Definition at line 104 of file kjavaapplet.cpp.
.SS "void KJavaApplet::setWindowName (const \fBQString\fP & title)"
.PP
Set the window title for swallowing. 
.PP
Definition at line 166 of file kjavaapplet.cpp.
.SS "\fBQString\fP & KJavaApplet::getWindowName ()"
.PP
Get the window title this applet should use. 
.PP
Definition at line 171 of file kjavaapplet.cpp.
.SS "void KJavaApplet::resizeAppletWidget (int width, int height)"
.PP
Interface for applets to resize themselves. 
.PP
Definition at line 149 of file kjavaapplet.cpp.
.PP
References endl(), jsData(), and kdDebug().
.SS "void KJavaApplet::create ()"
.PP
Send message to AppletServer to create this applet's frame to be swallowed and download the applet classes. 
.PP
Definition at line 181 of file kjavaapplet.cpp.
.PP
References KJavaAppletContext::create().
.PP
Referenced by KJavaAppletWidget::showApplet().
.SS "void KJavaApplet::init ()"
.PP
Send message to AppletServer to Initialize and show this applet. 
.PP
Definition at line 188 of file kjavaapplet.cpp.
.PP
References KJavaAppletContext::init().
.SS "bool KJavaApplet::isCreated ()"
.PP
Returns status of applet- whether it's been created or not. 
.PP
Definition at line 73 of file kjavaapplet.cpp.
.PP
Referenced by KJavaAppletWidget::showApplet().
.SS "void KJavaApplet::start ()"
.PP
Run the applet. 
.PP
Definition at line 193 of file kjavaapplet.cpp.
.PP
References KJavaAppletContext::start().
.PP
Referenced by stateChange().
.SS "void KJavaApplet::stop ()"
.PP
Pause the applet. 
.PP
Definition at line 198 of file kjavaapplet.cpp.
.PP
References KJavaAppletContext::stop().
.SS "int KJavaApplet::appletId ()"
.PP
Returns the unique ID this applet is given. 
.PP
Definition at line 203 of file kjavaapplet.cpp.
.SS "void KJavaApplet::setAppletId (int id)"
.PP
Set the applet ID. 
.PP
Definition at line 208 of file kjavaapplet.cpp.
.SS "void KJavaApplet::setUser (const \fBQString\fP & _user)\fC [inline]\fP"
.PP
Get/Set the user name. 
.PP
Definition at line 209 of file kjavaapplet.h.
.SS "void KJavaApplet::setPassword (const \fBQString\fP & _password)\fC [inline]\fP"
.PP
Get/Set the user password. 
.PP
Definition at line 215 of file kjavaapplet.h.
.SS "void KJavaApplet::setAuthName (const \fBQString\fP & _auth)\fC [inline]\fP"
.PP
Get/Set the auth name. 
.PP
Definition at line 221 of file kjavaapplet.h.
.SS "void KJavaApplet::stateChange (const int newState)"
.PP
called from the protocol engine changes the status according to the one on the java side. 
.PP
Do not call this yourself! 
.PP
Definition at line 213 of file kjavaapplet.cpp.
.PP
References appletName(), endl(), kdError(), and start().
.SS "void KJavaApplet::jsData (const \fBQStringList\fP & args)\fC [inline]\fP"
.PP
JavaScript coming from Java. 
.PP
Definition at line 237 of file kjavaapplet.h.
.PP
Referenced by resizeAppletWidget().

.SH "Author"
.PP 
Generated automatically by Doxygen for khtml Library from the source code.
