summaryrefslogtreecommitdiffstats
blob: c4ac4adbe4a71373bfb3e302738e8d609103d82a (plain)
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
/*
 * Copyright (c) 2012-2015 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */

#pragma once

#include <Swift/Controllers/Settings/SettingsProvider.h>

namespace Swift {
	/**
	 *  This class contains the major setting keys for Swift.
	 */
	class SettingConstants {
		public:
			/**
			 * The #IDLE_GOES_OFFLINE setting specifies whether to close the XMPP connection when
			 * the user went idle.
			 *
			 * True for automatic close of the XMPP connection and false for only changing the presence on idle.
			 */
			static const SettingsProvider::Setting<bool> IDLE_GOES_OFFLINE;
			/**
			 * The #IDLE_TIMEOUT setting specifieds the seconds the user has to be inactive at the 
			 * desktop so the user is regarded as idle.
			 */
			static const SettingsProvider::Setting<int> IDLE_TIMEOUT;
			static const SettingsProvider::Setting<bool> SHOW_NOTIFICATIONS;
			/**
			 * The #REQUEST_DELIVERYRECEIPTS settings specifies whether to request delivery receipts
			 * for messages to contacts that support message receipts.
			 */
			static const SettingsProvider::Setting<bool> REQUEST_DELIVERYRECEIPTS;
			static const SettingsProvider::Setting<bool> FORGET_PASSWORDS;
			static const SettingsProvider::Setting<bool> REMEMBER_RECENT_CHATS;
			static const SettingsProvider::Setting<std::string> LAST_LOGIN_JID;
			static const SettingsProvider::Setting<bool> LOGIN_AUTOMATICALLY;
			/**
			 * The #SHOW_OFFLINE setting specifies whether or not to show offline contacts in the 
			 * roster.
			 *
			 * If set true Swift will show offline contacts; else not.
			 */
			static const SettingsProvider::Setting<bool> SHOW_OFFLINE;
			/**
			 * The #EXPANDED_ROSTER_GROUPS setting specifies the list of groups that are expanded
			 * in the roster UI.
			 *
			 * Its value is a string with group names seperated by newlines.
			 */
			static const SettingsProvider::Setting<std::string> EXPANDED_ROSTER_GROUPS;
			static const SettingsProvider::Setting<bool> PLAY_SOUNDS;
			/**
			 * The #HIGHLIGHT_RULES setting specifies the highlight rules and the associated actions.
			 *
			 * Its value is a Boost serialized representation.
			 */
			static const SettingsProvider::Setting<std::string> HIGHLIGHT_RULES;
			static const SettingsProvider::Setting<bool> SPELL_CHECKER;
			static const SettingsProvider::Setting<std::string> DICT_PATH;
			static const SettingsProvider::Setting<std::string> PERSONAL_DICT_PATH;
			static const SettingsProvider::Setting<std::string> DICT_FILE;
			/**
			 * The #INVITE_AUTO_ACCEPT_MODE setting specifies how to handle invites to chat rooms.
			 * 
			 * Supported values are:
			 * - "no" : It is up to the user whether to accept the invitation and enter a room or not.
			 * - "presence" : The invitation is automatically accepted if it is from a contact that is 
			 *   already allowed to see the user's presence status.
			 * - "domain" : The invitation is automatically accepted if it is from a contact that is 
			 *   already allowed to see the user's presence status or from a contact of user's domain.
			 */
			static const SettingsProvider::Setting<std::string> INVITE_AUTO_ACCEPT_MODE;
			/**
			 * The #TRELLIS_GRID_SIZE setting specifies the dimensions of the grid used for the trellis
			 * layout.
			 *
			 * Its value is a Qt serialized representation.
			 */
			static const SettingsProvider::Setting<std::string> TRELLIS_GRID_SIZE;
			/**
			 * The #TRELLIS_GRID_POSITIONS setting specifies where conversations to contacts or rooms go 
			 * in the trellis grid.
			 *
			 * Its value is a Qt serialized representation.
			 */
			static const SettingsProvider::Setting<std::string> TRELLIS_GRID_POSITIONS;
			/**
			 * The #DISCONNECT_ON_CARD_REMOVAL setting
			 * specifies whether or not to sign out the user when
			 * the smartcard is removed.
			 *
			 * If set true Swift will sign out the user when the
			 * smart card is removed; else not.
			 */
			static const SettingsProvider::Setting<bool> DISCONNECT_ON_CARD_REMOVAL;
			/**
			 * The #SINGLE_SIGN_ON setting
			 * specifies whether to log in using Single Sign On.
			 * This is currently supported on Windows.
			 *
			 * If set true Swift will use GSSAPI authentication to
			 * log in the user; else not.
			 */
			static const SettingsProvider::Setting<bool> SINGLE_SIGN_ON;
	};
}