comparison: pidgin/pidgininfopane.h
pidgin/pidgininfopane.h
- changeset 42566
- ddaa27826ccc
- parent 42467
- 2b1d9d0770f2
- child 42577
- f8b477a1b0b6
equal
deleted
inserted
replaced
| 42565:c035e2eba80d | 42566:ddaa27826ccc |
|---|---|
| 41 * PidginInfoPane: | 41 * PidginInfoPane: |
| 42 * | 42 * |
| 43 * #PidginInfoPane is a widget that displays information above | 43 * #PidginInfoPane is a widget that displays information above |
| 44 * #PidginConversations. | 44 * #PidginConversations. |
| 45 * | 45 * |
| 46 * Since: 3.0.0 | 46 * Since: 3.0 |
| 47 */ | 47 */ |
| 48 | 48 |
| 49 #define PIDGIN_TYPE_INFO_PANE (pidgin_info_pane_get_type()) | 49 #define PIDGIN_TYPE_INFO_PANE (pidgin_info_pane_get_type()) |
| 50 | 50 |
| 51 PIDGIN_AVAILABLE_IN_3_0 | 51 PIDGIN_AVAILABLE_IN_3_0 |
| 52 G_DECLARE_FINAL_TYPE(PidginInfoPane, pidgin_info_pane, PIDGIN, INFO_PANE, | 52 G_DECLARE_FINAL_TYPE(PidginInfoPane, pidgin_info_pane, PIDGIN, INFO_PANE, |
| 53 GtkBox) | 53 GtkBox) |
| 54 | 54 |
| 55 /** | 55 /** |
| 56 * pidgin_info_pane_new: | 56 * pidgin_info_pane_new: |
| 57 * @conversation: The #PurpleConversation instance. | |
| 58 * | 57 * |
| 59 * Creates a new #PidginInfoPane instance that will display information about | 58 * Creates a new #PidginInfoPane instance. |
| 60 * @conversation. | |
| 61 * | 59 * |
| 62 * Returns: (transfer full): The new #PidginInfoPane instance. | 60 * Returns: (transfer full): The new #PidginInfoPane instance. |
| 63 * | 61 * |
| 64 * Since: 3.0.0 | 62 * Since: 3.0 |
| 65 */ | 63 */ |
| 66 PIDGIN_AVAILABLE_IN_3_0 | 64 PIDGIN_AVAILABLE_IN_3_0 |
| 67 GtkWidget *pidgin_info_pane_new(PurpleConversation *conversation); | 65 GtkWidget *pidgin_info_pane_new(void); |
| 68 | 66 |
| 69 /** | 67 /** |
| 70 * pidgin_info_pane_get_conversation: | 68 * pidgin_info_pane_get_title: |
| 71 * @pane: The #PidginInfoPane instance. | 69 * @pane: The #PidginInfoPane instance. |
| 72 * | 70 * |
| 73 * Gets the #PurpleConversation that @pane is displaying information for. | 71 * Gets the title of @pane. |
| 74 * | 72 * |
| 75 * Returns: (transfer none): The #PurpleConversation displayed by @pane. | 73 * Returns: (transfer none) (nullable): The title or %NULL. |
| 76 * | 74 * |
| 77 * Since: 3.0.0 | 75 * Since: 3.0 |
| 78 */ | 76 */ |
| 79 PIDGIN_AVAILABLE_IN_3_0 | 77 PIDGIN_AVAILABLE_IN_3_0 |
| 80 PurpleConversation *pidgin_info_pane_get_conversation(PidginInfoPane *pane); | 78 const char *pidgin_info_pane_get_title(PidginInfoPane *pane); |
| 81 | 79 |
| 82 /** | 80 /** |
| 83 * pidgin_info_pane_set_conversation: | 81 * pidgin_info_pane_set_title: |
| 84 * @pane: The instance. | 82 * @pane: The instance. |
| 85 * @conversation: (nullable): The [class@Purple.Conversation] to use. | 83 * @title: (nullable): The new title. |
| 86 * | 84 * |
| 87 * Sets the conversation that @pane uses to get its values. | 85 * Sets the title of @pane. |
| 88 * | 86 * |
| 89 * Typically this is only necessary for the conversation instance itself. | 87 * Since: 3.0 |
| 90 * | |
| 91 * Since: 3.0.0 | |
| 92 */ | 88 */ |
| 93 PIDGIN_AVAILABLE_IN_3_0 | 89 PIDGIN_AVAILABLE_IN_3_0 |
| 94 void pidgin_info_pane_set_conversation(PidginInfoPane *pane, PurpleConversation *conversation); | 90 void pidgin_info_pane_set_title(PidginInfoPane *pane, const char *title); |
| 91 | |
| 92 /** | |
| 93 * pidgin_info_pane_get_subtitle: | |
| 94 * @pane: The #PidginInfoPane instance. | |
| 95 * | |
| 96 * Gets the subtitle of @pane. | |
| 97 * | |
| 98 * Returns: (transfer none) (nullable): The subtitle or %NULL. | |
| 99 * | |
| 100 * Since: 3.0 | |
| 101 */ | |
| 102 PIDGIN_AVAILABLE_IN_3_0 | |
| 103 const char *pidgin_info_pane_get_subtitle(PidginInfoPane *pane); | |
| 104 | |
| 105 /** | |
| 106 * pidgin_info_pane_set_subtitle: | |
| 107 * @pane: The instance. | |
| 108 * @subtitle: (nullable): The new subtitle. | |
| 109 * | |
| 110 * Sets the subtitle of @pane. | |
| 111 * | |
| 112 * Since: 3.0 | |
| 113 */ | |
| 114 PIDGIN_AVAILABLE_IN_3_0 | |
| 115 void pidgin_info_pane_set_subtitle(PidginInfoPane *pane, const char *subtitle); | |
| 116 | |
| 117 /** | |
| 118 * pidgin_info_pane_get_child: | |
| 119 * @pane: The instance. | |
| 120 * | |
| 121 * Gets the widget that is being displayed at the end of @pane. | |
| 122 * | |
| 123 * Returns: (nullable): The child widget or %NULL if one is not set. | |
| 124 * | |
| 125 * Since: 3.0 | |
| 126 */ | |
| 127 PIDGIN_AVAILABLE_IN_3_0 | |
| 128 GtkWidget *pidgin_info_pane_get_child(PidginInfoPane *pane); | |
| 129 | |
| 130 /** | |
| 131 * pidgin_info_pane_set_child: | |
| 132 * @pane: The instance. | |
| 133 * @widget: (nullable): The new child. | |
| 134 * | |
| 135 * Sets the child widget of @pane to @widget. | |
| 136 * | |
| 137 * Since: 3.0 | |
| 138 */ | |
| 139 PIDGIN_AVAILABLE_IN_3_0 | |
| 140 void pidgin_info_pane_set_child(PidginInfoPane *pane, GtkWidget *widget); | |
| 95 | 141 |
| 96 G_END_DECLS | 142 G_END_DECLS |
| 97 | 143 |
| 98 #endif /* PIDGIN_INFO_PANE_H */ | 144 #endif /* PIDGIN_INFO_PANE_H */ |
