You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
290 lines
12 KiB
290 lines
12 KiB
//Auto-generated by kalyptus. DO NOT EDIT.
|
|
package org.kde.koala;
|
|
|
|
import org.kde.qt.Qt;
|
|
import java.util.ArrayList;
|
|
import org.kde.qt.QtSupport;
|
|
import org.kde.qt.QObject;
|
|
|
|
/**
|
|
|
|
Provides an interface for receiving DCOP messages.
|
|
This class provides an interface for receiving DCOP messages. To use it,
|
|
simply multiply-inherit from DCOPObject and from some other class, and
|
|
then implement the DCOPObject.process() method. Because this method is
|
|
pure virtual, you must implement the method.
|
|
Note that it is usually more convenient to mark a section in the class with
|
|
"k_dcop:", add your DCOP methods there and let the IDL compiler do the rest.
|
|
Read the tutorials for more information.
|
|
@author Preston Brown <pbrown@kde.org>, Matthias Ettrich <ettrich@kde.org>
|
|
|
|
@short Provides an interface for receiving DCOP messages.
|
|
@see DCOPClient
|
|
@see DCOPObjectProxy
|
|
|
|
*/
|
|
public class DCOPObject implements QtSupport, DCOPObjectInterface {
|
|
private long _qt;
|
|
private boolean _allocatedInJavaWorld = true;
|
|
protected DCOPObject(Class dummy){}
|
|
|
|
/**
|
|
Creates a DCOPObject and calculates the object id
|
|
using its physical memory address.
|
|
@short Creates a DCOPObject and calculates the object id using its physical memory address.
|
|
*/
|
|
public DCOPObject() {
|
|
newDCOPObject();
|
|
}
|
|
private native void newDCOPObject();
|
|
/**
|
|
Creates a DCOPObject and calculates the object id
|
|
using QObject.name().
|
|
@param obj the object to extract the name from
|
|
@short Creates a DCOPObject and calculates the object id using QObject.name().
|
|
*/
|
|
public DCOPObject(QObject arg1) {
|
|
newDCOPObject(arg1);
|
|
}
|
|
private native void newDCOPObject(QObject arg1);
|
|
/**
|
|
Creates a DCOPObject with object Id <code>objId.</code>
|
|
@param objId the object id of the DCOP object
|
|
@short Creates a DCOPObject with object Id <code>objId.</code>
|
|
*/
|
|
public DCOPObject(String objId) {
|
|
newDCOPObject(objId);
|
|
}
|
|
private native void newDCOPObject(String objId);
|
|
/**
|
|
Returns the object id of the DCOPObject.
|
|
@return the object's id
|
|
|
|
@short Returns the object id of the DCOPObject.
|
|
*/
|
|
public native String objId();
|
|
/**
|
|
Renames a dcop object, if no other with the same name exists
|
|
Use with care, all dcop signals are disconnected
|
|
@param objId the new object id
|
|
@short Renames a dcop object, if no other with the same name exists Use with care, all dcop signals are disconnected
|
|
*/
|
|
public native boolean setObjId(String objId);
|
|
/**
|
|
Dispatches a message.
|
|
Usually you want to use an IDL
|
|
compiler to automatically generate an implementation for
|
|
this function.
|
|
If this function returns false, then processDynamic()
|
|
is called.
|
|
Note to implementators: remember to call the baseclasses
|
|
implementation. It handles the functions "functions()" and
|
|
"interfaces()" which return the lists of supported functions
|
|
and interfaces, respectively.
|
|
@param fun is the normalized function signature.
|
|
Such a signature usually looks like
|
|
foobar(String,int). The return type,
|
|
qualifiers like "const" etc. are not part of
|
|
the signature.
|
|
@param data the received data
|
|
@param replyType write the reply type in this string
|
|
@param replyData write the reply data in this array
|
|
@return true if successful, false otherwise. The default implementation
|
|
returns false for all <code>fun</code> except "functions()" and
|
|
"interfaces()".
|
|
|
|
@short Dispatches a message.
|
|
@see DCOPClient#normalizeFunctionSignature
|
|
@see #functions
|
|
@see DCOPClient#process
|
|
*/
|
|
public native boolean process(String fun, byte[] data, StringBuffer replyType, byte[] replyData);
|
|
/**
|
|
This function is of interest when you used an IDL compiler
|
|
to generate the implementation for process() but
|
|
you still want to dispatch some functions dynamically.
|
|
Dynamically means that methods may appear and vanish
|
|
during runtime.
|
|
@param fun is the normalized function signature.
|
|
Such a signature usually looks like
|
|
foobar(String,int). The return type,
|
|
qualifiers like "const" etc. are not part of
|
|
the signature.
|
|
@param data the received data
|
|
@param replyType write the reply type in this string
|
|
@param replyData write the reply data in this array
|
|
@return true if successful, false otherwise. The default implementation
|
|
returns always false.
|
|
|
|
@short This function is of interest when you used an IDL compiler to generate the implementation for process() but you still want to dispatch some functions dynamically.
|
|
@see #process
|
|
@see DCOPClient#normalizeFunctionSignature
|
|
@see #functions
|
|
@see DCOPClient#process
|
|
*/
|
|
public native boolean processDynamic(String fun, byte[] data, StringBuffer replyType, byte[] replyData);
|
|
/**
|
|
This function is of interest when you used an IDL compiler
|
|
to generate the implementation for functions() but
|
|
you still want to list some functions dynamically.
|
|
Dynamically means that the methods may appear and vanish
|
|
during runtime.
|
|
@return A list of the additional functions, default is an empty list.
|
|
|
|
@short This function is of interest when you used an IDL compiler to generate the implementation for functions() but you still want to list some functions dynamically.
|
|
@see #functions
|
|
*/
|
|
public native ArrayList functionsDynamic();
|
|
/**
|
|
This function is of interest when you used an IDL compiler
|
|
to generate the implementation for interfaces() but
|
|
you still want to list some interfaces dynamically.
|
|
Dynamically means that they may appear and vanish
|
|
during runtime.
|
|
@return A list of the additional interfaces, default is an empty list.
|
|
|
|
@short This function is of interest when you used an IDL compiler to generate the implementation for interfaces() but you still want to list some interfaces dynamically.
|
|
@see #interfaces
|
|
*/
|
|
public native ArrayList interfacesDynamic();
|
|
/**
|
|
Returns the names of the interfaces, specific ones last. The
|
|
functions gets reimplemented by the IDL compiler. If you don't
|
|
use the IDL compiler, consider implementing this function
|
|
manually if you want your object to be easily explorable.
|
|
@return a list of interfaces
|
|
|
|
@short Returns the names of the interfaces, specific ones last.
|
|
@see #functions
|
|
*/
|
|
public native ArrayList interfaces();
|
|
/**
|
|
Returns the list of functions understood by the object. It gets
|
|
reimplemented by the IDL compiler. If you don't use the IDL
|
|
compiler, consider implementing this function manually if you
|
|
want your object to be easily scriptable.
|
|
Rationale: functions() allows an interpreter to do client-side
|
|
type-casting properly.
|
|
Note to implementators: remember to call the baseclasses
|
|
implementation.
|
|
@return a list of functions
|
|
|
|
@short Returns the list of functions understood by the object.
|
|
@see #interfaces
|
|
@see #process
|
|
@see #processDynamic
|
|
@see DCOPClient#normalizeFunctionSignature
|
|
*/
|
|
public native ArrayList functions();
|
|
/**
|
|
Emit <code>signal</code> as DCOP signal from this object with <code>data</code> as
|
|
arguments
|
|
@param signal the signal to emit
|
|
@param data the data to send
|
|
@short Emit <code>signal</code> as DCOP signal from this object with <code>data</code> as arguments
|
|
*/
|
|
public native void emitDCOPSignal(String signal, byte[] data);
|
|
/**
|
|
Connects to a DCOP signal.
|
|
@param sender the name of the client that emits the signal. When empty
|
|
the signal will be passed from any client.
|
|
@param senderObj the name of the sending object that emits the signal.
|
|
@param signal the name of the signal. The arguments should match with slot.
|
|
@param slot The name of the slot to call. Its arguments should match with signal.
|
|
@param Volatile If true, the connection will not be reestablished when
|
|
<code>sender</code> unregisters and reregisters with DCOP. In this case the <code>sender</code>
|
|
must be registered when the connection is made.
|
|
If false, the connection will be reestablished when <code>sender</code> reregisters.
|
|
In this case the connection can be made even if <code>sender</code> is not registered
|
|
at that time.
|
|
|
|
<li>
|
|
<code>Volatile</code> is true and <code>sender</code> does not exist.
|
|
</li>
|
|
|
|
<li>
|
|
<code>signal</code> and <code>slot</code> do not have matching arguments.
|
|
|
|
</li> @return false if a connection could not be established.
|
|
This will be the case when
|
|
|
|
@short Connects to a DCOP signal.
|
|
*/
|
|
public native boolean connectDCOPSignal(String sender, String senderObj, String signal, String slot, boolean Volatile);
|
|
/**
|
|
Disconnects a DCOP signal.
|
|
A special case is when both <code>sender</code> & <code>signal</code> are empty. In this
|
|
case all connections related to this object in the current client
|
|
are disconnected. (Both connections from as well as to this object!)
|
|
@param sender the name of the client that emits the signal.
|
|
@param senderObj the name of the object that emits the signal.
|
|
If empty all objects will be disconnected.
|
|
@param signal the name of the signal. The arguments should match with slot.
|
|
If empty all objects will be disconnected.
|
|
@param slot The name of the slot the signal is connected to.
|
|
If empty all slots will be disconnected.
|
|
@return false if no connection(s) where removed.
|
|
|
|
@short Disconnects a DCOP signal.
|
|
*/
|
|
public native boolean disconnectDCOPSignal(String sender, String senderObj, String signal, String slot);
|
|
/**
|
|
Returns the DCOPClient responsible for making the call.
|
|
Only call this function while you are handling a DCOP call.
|
|
@return the DCOPClient responsible for making the call.
|
|
This information is only guaranteed to be correct when
|
|
entering your DCOP function.
|
|
|
|
@short Returns the DCOPClient responsible for making the call.
|
|
*/
|
|
public native DCOPClient callingDcopClient();
|
|
/**
|
|
@short
|
|
*/
|
|
public native void setCallingDcopClient(DCOPClient arg1);
|
|
/**
|
|
Checks whether an object with the given id is known in this process.
|
|
DCOPObjectProxy
|
|
@return true if an object with the questionable <code>objId</code> is
|
|
known in this process. This query does not ask proxies.
|
|
|
|
@short Checks whether an object with the given id is known in this process.
|
|
*/
|
|
public static native boolean hasObject(String objId);
|
|
/**
|
|
Try to find a dcop object with the given id.
|
|
This function does not query the DCOPObjectProxy.
|
|
@param objId the object id to search
|
|
@return the DCOPObject for the id <code>objId.</code>
|
|
|
|
@short Try to find a dcop object with the given id.
|
|
*/
|
|
public static native DCOPObjectInterface find(String objId);
|
|
/**
|
|
Tries to find an object using a partial object id.
|
|
This function is used for multicasting a DCOP message to
|
|
several objects inside a single process.
|
|
@param partialId the partial object id to search for
|
|
@return a list of DCOPObjects beginning with the string
|
|
contained in <code>partialId.</code>
|
|
|
|
@short Tries to find an object using a partial object id.
|
|
*/
|
|
// QPtrList<DCOPObject> match(const QCString& arg1); >>>> NOT CONVERTED
|
|
/**
|
|
Creates an object id for the QObject <code>obj.</code> This is done
|
|
using the QObject.name() function.
|
|
@param obj the object whose name will be used
|
|
@return the created object id
|
|
|
|
@short Creates an object id for the QObject <code>obj.</code>
|
|
*/
|
|
public static native String objectName(QObject arg1);
|
|
/** Deletes the wrapped C++ instance */
|
|
protected native void finalize() throws InternalError;
|
|
/** Delete the wrapped C++ instance ahead of finalize() */
|
|
public native void dispose();
|
|
/** Has the wrapped C++ instance been deleted? */
|
|
public native boolean isDisposed();
|
|
}
|