• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • dcop
 

dcop

Public Types | Public Member Functions | Protected Types | Protected Member Functions | List of all members
DCOPStub Class Reference

#include <dcopstub.h>

Public Types

enum  Status { CallSucceeded, CallFailed }
 

Public Member Functions

 DCOPStub (const TQCString &app, const TQCString &obj)
 
 DCOPStub (DCOPClient *client, const TQCString &app, const TQCString &obj)
 
 DCOPStub (const DCOPRef &ref)
 
TQCString app () const
 
TQCString obj () const
 
Status status () const
 
bool ok () const
 

Protected Types

enum  never_use_t { never_use }
 

Protected Member Functions

void setStatus (Status _status)
 
virtual void callFailed ()
 
DCOPClient * dcopClient ()
 
 DCOPStub (never_use_t)
 
virtual void virtual_hook (int id, void *data)
 

Detailed Description

Abstract base class for dcop stubs as created by the dcopidl2cpp compiler.

Definition at line 41 of file dcopstub.h.

Constructor & Destructor Documentation

DCOPStub::DCOPStub ( const TQCString &  app,
const TQCString &  obj 
)

Creates a DCOPStub for application app and object obj.

Parameters
appthe application id
objthe object id

Definition at line 36 of file dcopstub.cpp.

DCOPStub::DCOPStub ( DCOPClient *  client,
const TQCString &  app,
const TQCString &  obj 
)

Creates a DCOPStub for application app and object obj that operates on the DCOPClient client.

Parameters
clientthe DCOPClient
appthe application id
objthe object id

Definition at line 41 of file dcopstub.cpp.

DCOPStub::DCOPStub ( const DCOPRef &  ref)
explicit

Creates a DCOPStub for application ref.app() and object ref.obj()

Parameters
refthe DCOP reference

Definition at line 50 of file dcopstub.cpp.

Member Function Documentation

TQCString DCOPStub::app ( ) const

Return the application id.

Returns
the application id

Definition at line 87 of file dcopstub.cpp.

void DCOPStub::callFailed ( )
protectedvirtual

Invoked whenever a call fails.

The default implementation sets the status to CallFailed.

Definition at line 82 of file dcopstub.cpp.

DCOPClient * DCOPStub::dcopClient ( )
protected

The dcopClient this stub operates on.

Either the specific one specified in the constructor or DCOPClient::mainClient.

Returns
the stub's DCOPClient

Definition at line 60 of file dcopstub.cpp.

TQCString DCOPStub::obj ( ) const

Return the object id.

Returns
the object id

Definition at line 92 of file dcopstub.cpp.

bool DCOPStub::ok ( ) const

Return whether no error occurred,.

Returns
true if the last call was successful, false otherwise
See Also
status();

Definition at line 77 of file dcopstub.cpp.

void DCOPStub::setStatus ( Status  _status)
protected

Sets the status to status.

Possible values are 'CallSucceeded' and 'CallFailed'

Parameters
_statusthe new status
See Also
status()

Definition at line 72 of file dcopstub.cpp.

DCOPStub::Status DCOPStub::status ( ) const

Return the status of the last call, either CallSucceeded or CallFailed.

Returns
the status of the last call
See Also
ok();

Definition at line 67 of file dcopstub.cpp.


The documentation for this class was generated from the following files:
  • dcopstub.h
  • dcopstub.cpp

dcop

Skip menu "dcop"
  • Main Page
  • Modules
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

dcop

Skip menu "dcop"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for dcop by doxygen 1.8.3.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |