1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*
Kopete Utils.
Copyright (c) 2005 Duncan Mac-Vicar Prett <[email protected]>
Kopete (c) 2002-2003 by the Kopete developers <[email protected]>
*************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
*************************************************************************
*/
#ifndef KOPETE_UTILS_H
#define KOPETE_UTILS_H
#include "tqobject.h"
#include "tqstring.h"
#include "tqpixmap.h"
#include "kopete_export.h"
class KNotification;
namespace Kopete
{
class Account;
namespace Utils
{
/**
* Checks if host is accesible. Useful for plugins to check for disconnected events.
*
* @param host The host to be cheked
*/
bool isHostReachable( const TQString &host );
/**
* Notifies the user connection has been lost without coupling plugins with GUI code.
*
* @param account The account that lost the connection and wants to notify the user.
* @param caption A brief subject line, used where possible if the presentation allows it.
* @param message A short description of the error.
* @param explanation A long description on how the error occured and what the user can do about it.
* @param debugInfo Debug info that can be sent to the developers or to the network service owners.
*
* You can not provide debugInfo without an user explanation. If you don't provide a caption, message, or
* explanation, Kopete will use a default explanation.
*/
void KOPETE_EXPORT notifyConnectionLost( const Account *account,
const TQString &caption = TQString::null,
const TQString &message = TQString::null,
const TQString &explanation = TQString::null,
const TQString &debugInfo = TQString::null );
/**
* Notifies the user the server is not reachable without coupling plugins with GUI code.
*
* @param account The account that cannot establish a connection and want to notify the user about that.
* @param explanation A long description on how the error occured and what the user can do about it.
* @param debugInfo Debug info that can be sent to the developers or to the network service owners.
*
* You can not provide debugInfo without an user explanation. If you don't provide a caption, message, or
* explanation, Kopete will use a default explanation.
*/
void KOPETE_EXPORT notifyCannotConnect( const Account *account,
const TQString &explanation = TQString::null,
const TQString &debugInfo = TQString::null);
/**
* Notifies the user that an error on a connection occcured without coupling plugins with GUI code.
*
* @param account The account where the connection error occured and wants to notify the user.
* @param caption A brief subject line, used where possible if the presentation allows it.
* @param message A short description of the error.
* @param explanation A long description on how the error occured and what the user can do about it.
* @param debugInfo Debug info that can be sent to the developers or to the network service owners.
*
* You can not provide debugInfo without an user explanation. If you don't provide a caption, message, or
* explanation, Kopete will use a default explanation.
*/
void KOPETE_EXPORT notifyConnectionError( const Account *account,
const TQString &caption = TQString::null,
const TQString &message = TQString::null,
const TQString &explanation = TQString::null,
const TQString &debugInfo = TQString::null );
/**
* Notifies the user that an error on the server occcured without coupling plugins with GUI code.
*
* @param account The account where the server error occured and wants to notify the user.
* @param caption A brief subject line, used where possible if the presentation allows it.
* @param message A short description of the error.
* @param explanation A long description on how the error occured and what the user can do about it.
* @param debugInfo Debug info that can be sent to the developers or to the network service owners.
*
* You can not provide debugInfo without an user explanation. If you don't provide a caption, message, or
* explanation, Kopete will use a default explanation.
*/
void KOPETE_EXPORT notifyServerError( const Account *account,
const TQString &caption = TQString::null,
const TQString &message = TQString::null,
const TQString &explanation = TQString::null,
const TQString &debugInfo = TQString::null );
} // end ns Utils
} // end ns Kopete
#endif
|
