• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KXMessages Class Reference

Sending string messages to other applications using the X Client Messages. More...

#include <kxmessages.h>

Inheritance diagram for KXMessages:
QWidget

List of all members.

Signals

void gotMessage (const QString &message)

Public Member Functions

void broadcastMessage (const char *msg_type, const QString &message)
void broadcastMessage (const char *msg_type, const QString &message, int screen, bool obsolete)
 KXMessages (const char *accept_broadcast=NULL, QWidget *parent=NULL)
 KXMessages (const char *accept_broadcast, QWidget *parent, bool obsolete)
void sendMessage (WId w, const char *msg_type, const QString &message)
void sendMessage (WId w, const char *msg_type, const QString &message, bool obsolete)
virtual ~KXMessages ()

Static Public Member Functions

static bool broadcastMessageX (Display *disp, const char *msg_type, const QString &message)
static bool broadcastMessageX (Display *disp, const char *msg_type, const QString &message, int screen, bool obsolete)
static bool sendMessageX (Display *disp, WId w, const char *msg_type, const QString &message)
static bool sendMessageX (Display *disp, WId w, const char *msg_type, const QString &message, bool obsolete)

Protected Member Functions

virtual bool x11Event (XEvent *ev)

Detailed Description

Sending string messages to other applications using the X Client Messages.

Used internally by KStartupInfo. You usually don't want to use this, use DBUS instead.

Author:
Lubos Lunak <l.lunak@kde.org>

Definition at line 46 of file kxmessages.h.


Constructor & Destructor Documentation

KXMessages::KXMessages ( const char *  accept_broadcast,
QWidget *  parent,
bool  obsolete 
)

Creates an instance which will receive X messages.

Parameters:
accept_broadcast if non-NULL, all broadcast messages with this message type will be received.
parent the parent of this widget
obsolete always set to false (needed for backwards compatibility with KDE3.1 and older)

Definition at line 66 of file kxmessages.cpp.

KXMessages::KXMessages ( const char *  accept_broadcast = NULL,
QWidget *  parent = NULL 
) [explicit]
Deprecated:
This method is equivalent to the other constructor with obsolete = true.

Definition at line 48 of file kxmessages.cpp.

KXMessages::~KXMessages (  )  [virtual]

Definition at line 85 of file kxmessages.cpp.


Member Function Documentation

void KXMessages::broadcastMessage ( const char *  msg_type,
const QString &  message 
)
Deprecated:
This method is equivalent to broadcastMessage() with obsolete = true.

Definition at line 91 of file kxmessages.cpp.

void KXMessages::broadcastMessage ( const char *  msg_type,
const QString &  message,
int  screen,
bool  obsolete 
)

Broadcasts the given message with the given message type.

Parameters:
msg_type the type of the message
message the message itself
screen X11 screen to use, -1 for the default
obsolete always set to false (needed for backwards compatibility with KDE3.1 and older)

Definition at line 96 of file kxmessages.cpp.

bool KXMessages::broadcastMessageX ( Display *  disp,
const char *  msg_type,
const QString &  message 
) [static]
Deprecated:
This method is equivalent to broadcastMessageX() with obsolete = true.

Definition at line 119 of file kxmessages.cpp.

bool KXMessages::broadcastMessageX ( Display *  disp,
const char *  msg_type,
const QString &  message,
int  screen,
bool  obsolete 
) [static]

Broadcasts the given message with the given message type.

Parameters:
disp X11 connection which will be used instead of qt_x11display()
msg_type the type of the message
message the message itself
screen X11 screen to use, -1 for the default
obsolete always set to false (needed for backwards compatibility with KDE3.1 and older)
Returns:
false when an error occurred, true otherwise

Definition at line 125 of file kxmessages.cpp.

void KXMessages::gotMessage ( const QString &  message  )  [signal]

Emitted when a message was received.

Parameters:
message the message that has been received
void KXMessages::sendMessage ( WId  w,
const char *  msg_type,
const QString &  message 
)
Deprecated:
This method is equivalent to sendMessage() with obsolete = true.

Definition at line 106 of file kxmessages.cpp.

void KXMessages::sendMessage ( WId  w,
const char *  msg_type,
const QString &  message,
bool  obsolete 
)

Sends the given message with the given message type only to given window.

Parameters:
w X11 handle for the destination window
msg_type the type of the message
message the message itself
obsolete always set to false (needed for backwards compatibility with KDE3.1 and older)

Definition at line 111 of file kxmessages.cpp.

bool KXMessages::sendMessageX ( Display *  disp,
WId  w,
const char *  msg_type,
const QString &  message 
) [static]
Deprecated:
This method is equivalent to sendMessageX() with obsolete = true.

Definition at line 142 of file kxmessages.cpp.

bool KXMessages::sendMessageX ( Display *  disp,
WId  w,
const char *  msg_type,
const QString &  message,
bool  obsolete 
) [static]

Sends the given message with the given message type only to given window.

Parameters:
disp X11 connection which will be used instead of qt_x11display()
w X11 handle for the destination window
msg_type the type of the message
message the message itself
obsolete always set to false (needed for backwards compatibility with KDE3.1 and older)
Returns:
false when an error occurred, true otherwise

Definition at line 148 of file kxmessages.cpp.

bool KXMessages::x11Event ( XEvent *  ev  )  [protected, virtual]

For internal use only.

Definition at line 189 of file kxmessages.cpp.


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

KDEUI

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal