Kopete::InfoEvent Class Reference

#include <kopeteinfoevent.h>

Inheritance diagram for Kopete::InfoEvent:

Public Slots
virtual void	activate (uint actionId)
void	close ()
virtual void	sendEvent ()

Signals
void	actionActivated (uint actionId)
void	changed ()
void	eventClosed (Kopete::InfoEvent *event)

Public Member Functions
	InfoEvent (QObject *parent=0)
	~InfoEvent ()
QMap< uint, QString >	actions () const
void	addAction (uint actionId, const QString &actionText)
QString	additionalText () const
bool	isClosed () const
void	setAdditionalText (const QString &text)
void	setShowOnSend (bool showOnSend)
void	setText (const QString &text)
void	setTitle (const QString &title)
bool	showOnSend () const
QString	text () const
QString	title () const

Detailed Description

Base class for all Info Events.

The info event will be shown in non-intrusive way to user in Kopete Main Window.

You have to use sendEvent to show the event.

The pointer is automatically deleted when the event is closed.

Author

Roman Jarosz kedge.nosp@m.dev@.nosp@m.centr.nosp@m.um.c.nosp@m.z

Definition at line 39 of file kopeteinfoevent.h.

Constructor & Destructor Documentation

Kopete::InfoEvent::InfoEvent

(

QObject *

parent = 0

)

Definition at line 36 of file kopeteinfoevent.cpp.

Kopete::InfoEvent::~InfoEvent

(

)

Definition at line 43 of file kopeteinfoevent.cpp.

Member Function Documentation

void Kopete::InfoEvent::actionActivated ( uint  actionId )

signal

A action has been activated.

This signal is only emitted if activate( uint ) is not replaced.

Parameters

actionId

is the id of the activated action.

QMap< uint, QString > Kopete::InfoEvent::actions

(

)

const

Returns

the list of actions

Definition at line 89 of file kopeteinfoevent.cpp.

void Kopete::InfoEvent::activate ( uint  actionId )

virtualslot

Activate the action specified action.

Definition at line 110 of file kopeteinfoevent.cpp.

void Kopete::InfoEvent::addAction	(	uint	actionId,
		const QString &	actionText
	)

Set the list of actions link.

Parameters

actions

the list of actions

Definition at line 94 of file kopeteinfoevent.cpp.

QString Kopete::InfoEvent::additionalText

(

)

const

Returns

the additional text

Definition at line 78 of file kopeteinfoevent.cpp.

void Kopete::InfoEvent::changed ( )

signal

User visible data has been changed.

void Kopete::InfoEvent::close ( )

slot

Close the info event.

This will delete the info event.

Definition at line 120 of file kopeteinfoevent.cpp.

void Kopete::InfoEvent::eventClosed ( Kopete::InfoEvent *  event )

signal

Emitted when the info event is closed.

bool Kopete::InfoEvent::isClosed

(

)

const

Returns

true if event has been closed and is scheduled for deletion.

Definition at line 115 of file kopeteinfoevent.cpp.

void Kopete::InfoEvent::sendEvent ( )

virtualslot

Emit the event.

Definition at line 51 of file kopeteinfoevent.cpp.

void Kopete::InfoEvent::setAdditionalText

(

const QString &

text

)

Set the additional text.

This is only shown in InfoEditWidget

Parameters

text	the additional text

Definition at line 83 of file kopeteinfoevent.cpp.

void Kopete::InfoEvent::setShowOnSend

(

bool

showOnSend

)

Set if event should automatically be shown in contact list window.

Parameters

showOnSend

the show flag

Definition at line 105 of file kopeteinfoevent.cpp.

void Kopete::InfoEvent::setText

(

const QString &

text

)

Set the Info Event text.

The text is shown in a QLabel, you should make sure to escape any html that is needed. You can use some of the qt basic html tags.

This text will also be shown in KNotification popup

Parameters

text

the text

Definition at line 72 of file kopeteinfoevent.cpp.

void Kopete::InfoEvent::setTitle

(

const QString &

title

)

Set the Info Event title.

Parameters

title

the title

Definition at line 61 of file kopeteinfoevent.cpp.

bool Kopete::InfoEvent::showOnSend

(

)

const

Returns

true if event should automatically be shown in contact list window

Definition at line 100 of file kopeteinfoevent.cpp.

QString Kopete::InfoEvent::text

(

)

const

Returns

the Info Event text

Definition at line 67 of file kopeteinfoevent.cpp.

QString Kopete::InfoEvent::title

(

)

const

Returns

the Info Event title

Definition at line 56 of file kopeteinfoevent.cpp.

---

The documentation for this class was generated from the following files:

• kopeteinfoevent.h
• kopeteinfoevent.cpp