pidgin/pidginiconname.h

Wed, 01 Jan 2025 15:32:28 -0600

author
Gary Kramlich <grim@reaperworld.com>
date
Wed, 01 Jan 2025 15:32:28 -0600
changeset 43120
a7fd7e06c486
parent 42700
3e480ee2d7ee
permissions
-rw-r--r--

Prepare for the 2.90.1 release

Testing Done:
Ran `meson dist`

Reviewed at https://reviews.imfreedom.org/r/3716/

41027
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
1 /*
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
2 * Pidgin - Internet Messenger
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
3 * Copyright (C) Pidgin Developers <devel@pidgin.im>
39498
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
4 *
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
5 * Pidgin is the legal property of its developers, whose names are too numerous
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
6 * to list here. Please refer to the COPYRIGHT file distributed with this
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
7 * source distribution.
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
8 *
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
9 * This program is free software; you can redistribute it and/or modify
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
10 * it under the terms of the GNU General Public License as published by
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
11 * the Free Software Foundation; either version 2 of the License, or
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
12 * (at your option) any later version.
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
13 *
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
14 * This program is distributed in the hope that it will be useful,
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
17 * GNU General Public License for more details.
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
18 *
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
19 * You should have received a copy of the GNU General Public License
41027
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
20 * along with this program; if not, see <https://www.gnu.org/licenses/>.
39498
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
21 */
51e0448a7ae8 Move relnot to not using STOCK and start the transition layer
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
22
40502
875489636847 pidgin.h phase3: create pidgin.h and force its usage
Gary Kramlich <grim@reaperworld.com>
parents: 39500
diff changeset
23 #if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
875489636847 pidgin.h phase3: create pidgin.h and force its usage
Gary Kramlich <grim@reaperworld.com>
parents: 39500
diff changeset
24 # error "only <pidgin.h> may be included directly"
875489636847 pidgin.h phase3: create pidgin.h and force its usage
Gary Kramlich <grim@reaperworld.com>
parents: 39500
diff changeset
25 #endif
875489636847 pidgin.h phase3: create pidgin.h and force its usage
Gary Kramlich <grim@reaperworld.com>
parents: 39500
diff changeset
26
41027
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
27 #ifndef PIDGIN_ICON_NAME_H
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
28 #define PIDGIN_ICON_NAME_H
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
29
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
30 #include <glib.h>
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
31
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
32 #include <purple.h>
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
33
42466
ca3374c1cdba Add visibility to all Pidgin symbols tagged with Since 3.0
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 41124
diff changeset
34 #include "pidginversion.h"
ca3374c1cdba Add visibility to all Pidgin symbols tagged with Since 3.0
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 41124
diff changeset
35
41027
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
36 G_BEGIN_DECLS
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
37
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
38 /**
42476
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
39 * pidgin_icon_name_from_presence_primitive:
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
40 * @primitive: The [enum@Purple.PresencePrimitive].
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
41 * @fallback: The icon name to fall back to.
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
42 *
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
43 * Gets the icon name that should be used to represent @primitive. If the value
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
44 * is unknown @fallback will be returned.
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
45 *
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
46 * Returns: (nullable): The icon name to use or @fallback.
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
47 *
42620
72178a341eb8 Remove minor versions from Since tags in Pidgin
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 42476
diff changeset
48 * Since: 3.0
42476
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
49 */
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
50 PIDGIN_AVAILABLE_IN_3_0
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
51 const char *pidgin_icon_name_from_presence_primitive(PurplePresencePrimitive primitive, const char *fallback);
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
52
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
53 /**
41027
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
54 * pidgin_icon_name_from_presence:
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
55 * @presence: The #PurplePresence instance.
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
56 * @fallback: The icon name to fall back to.
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
57 *
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
58 * Gets the icon name that should be used to represent @presence falling back
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
59 * to @fallback if @presence is invalid.
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
60 *
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
61 * Returns: The icon name to represent @presence.
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
62 *
42620
72178a341eb8 Remove minor versions from Since tags in Pidgin
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 42476
diff changeset
63 * Since: 3.0
41027
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
64 */
42466
ca3374c1cdba Add visibility to all Pidgin symbols tagged with Since 3.0
Elliott Sales de Andrade <quantum.analyst@gmail.com>
parents: 41124
diff changeset
65 PIDGIN_AVAILABLE_IN_3_0
42476
5b5e6297cd31 Add a pidgin_icon_name_from_presence_primitive
Gary Kramlich <grim@reaperworld.com>
parents: 42466
diff changeset
66 const char *pidgin_icon_name_from_presence(PurplePresence *presence, const char *fallback);
41027
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
67
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
68 G_END_DECLS
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
69
aa0e688f2f46 Add a bunch of icon name utility functions
Gary Kramlich <grim@reaperworld.com>
parents: 40502
diff changeset
70 #endif /* PIDGIN_ICON_NAME_H */

mercurial