.TH "KIPC" 3 "28 Jan 2004" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIPC \- This class implements a very simple IPC mechanism for \fBKDE\fP.  

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

.in +1c
.ti -1c
.RI "enum \fBMessage\fP { \fBPaletteChanged\fP = 0, \fBFontChanged\fP, \fBStyleChanged\fP, \fBBackgroundChanged\fP, \fBSettingsChanged\fP, \fBIconChanged\fP, \fBToolbarStyleChanged\fP, \fBClipboardConfigChanged\fP, \fBUserMessage\fP = 32 }"
.br
.RI "\fIA identifier for messages. \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBsendMessage\fP (\fBMessage\fP msg, WId w, int data=0)"
.br
.RI "\fISend a message to a specific application. \fP"
.ti -1c
.RI "void \fBsendMessageAll\fP (\fBMessage\fP msg, int data=0)"
.br
.RI "\fISend a message to all \fBKDE\fP application on the current display. \fP"
.in -1c
.SH "Detailed Description"
.PP 
This class implements a very simple IPC mechanism for \fBKDE\fP. 

You can send a message of a predefined type to either a specific application, or to all \fBKDE\fP application on the current display. The message can carry one integer of data.
.PP
KIPC is mainly used in \fBKDE\fP for sending 'Change Messages', i.e. a message to all \fBKDE\fP apps that a certain setting (the font, for example) has changed. For anything more complex it is recommended to use DCOP -- the Desktop Communications Protocol.
.PP
Messages with id code < 32 are called 'System Messages'. These are directly handled by \fBKApplication\fP. Examples are: PaletteChanged and StyleChanged. Messages with id code >= 32 are user messages. \fBKApplication\fP emits the signal kipcMessage(id,arg) for each user message it receives.
.PP
KIPC is implemented using X11 ClientMessage events.
.PP
\fBSee also:\fP
.RS 4
\fBKApplication::kipcMessage()\fP 
.RE
.PP
\fBAuthor:\fP
.RS 4
Geert Jansen <jansen@kde.org> 
.RE
.PP
\fBVersion:\fP
.RS 4
\fBId\fP.RS 4
\fBkipc.h\fP,v 1.15.2.1 2003/06/06 09:12:16 mueller Exp 
.RE
.PP
.RE
.PP

.PP
Definition at line 49 of file kipc.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKIPC::Message\fP"
.PP
A identifier for messages. Messages below UserMessage are system messages, messages above can be defined by the user. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIUserMessage \fP\fP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 56 of file kipc.h.
.SH "Member Function Documentation"
.PP 
.SS "void KIPC::sendMessage (\fBMessage\fP msg, WId w, int data = 0)\fC [static]\fP"
.PP
Send a message to a specific application. \fBParameters:\fP
.RS 4
\fImsg\fP The message to send. 
.br
\fIw\fP The window id of a toplevel window of the target application. 
.br
\fIdata\fP An optional integer of data. 
.RE
.PP
Definition at line 62 of file kipc.cpp.
.PP
Referenced by sendMessageAll().
.SS "void KIPC::sendMessageAll (\fBMessage\fP msg, int data = 0)\fC [static]\fP"
.PP
Send a message to all \fBKDE\fP application on the current display. \fBParameters:\fP
.RS 4
\fImsg\fP The message to send. 
.br
\fIdata\fP An optional integer of data. 
.RE
.PP
Definition at line 89 of file kipc.cpp.
.PP
References sendMessage().

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