libpurple/theme.h

branch
soc.2013.gobjectification.plugins
changeset 37017
8e2b68c79fa1
parent 35024
eb3afb7643ce
child 35403
9282701d7aa9
child 37023
d9bcdc9a91e6
equal deleted inserted replaced
37016:48f85579cc4c 37017:8e2b68c79fa1
74 GType purple_theme_get_type(void); 74 GType purple_theme_get_type(void);
75 75
76 /** 76 /**
77 * Returns the name of the PurpleTheme object. 77 * Returns the name of the PurpleTheme object.
78 * 78 *
79 * @param theme The purple theme. 79 * @theme: The purple theme.
80 * 80 *
81 * @return The string representing the name of the theme. 81 * Returns: The string representing the name of the theme.
82 */ 82 */
83 const gchar *purple_theme_get_name(PurpleTheme *theme); 83 const gchar *purple_theme_get_name(PurpleTheme *theme);
84 84
85 /** 85 /**
86 * Sets the name of the PurpleTheme object. 86 * Sets the name of the PurpleTheme object.
87 * 87 *
88 * @param theme The purple theme. 88 * @theme: The purple theme.
89 * @param name The name of the PurpleTheme object. 89 * @name: The name of the PurpleTheme object.
90 */ 90 */
91 void purple_theme_set_name(PurpleTheme *theme, const gchar *name); 91 void purple_theme_set_name(PurpleTheme *theme, const gchar *name);
92 92
93 /** 93 /**
94 * Returns the description of the PurpleTheme object. 94 * Returns the description of the PurpleTheme object.
95 * 95 *
96 * @param theme The purple theme. 96 * @theme: The purple theme.
97 * 97 *
98 * @return A short description of the theme. 98 * Returns: A short description of the theme.
99 */ 99 */
100 const gchar *purple_theme_get_description(PurpleTheme *theme); 100 const gchar *purple_theme_get_description(PurpleTheme *theme);
101 101
102 /** 102 /**
103 * Sets the description of the PurpleTheme object. 103 * Sets the description of the PurpleTheme object.
104 * 104 *
105 * @param theme The purple theme. 105 * @theme: The purple theme.
106 * @param description The description of the PurpleTheme object. 106 * @description: The description of the PurpleTheme object.
107 */ 107 */
108 void purple_theme_set_description(PurpleTheme *theme, const gchar *description); 108 void purple_theme_set_description(PurpleTheme *theme, const gchar *description);
109 109
110 /** 110 /**
111 * Returns the author of the PurpleTheme object. 111 * Returns the author of the PurpleTheme object.
112 * 112 *
113 * @param theme The purple theme. 113 * @theme: The purple theme.
114 * 114 *
115 * @return The author of the theme. 115 * Returns: The author of the theme.
116 */ 116 */
117 const gchar *purple_theme_get_author(PurpleTheme *theme); 117 const gchar *purple_theme_get_author(PurpleTheme *theme);
118 118
119 /** 119 /**
120 * Sets the author of the PurpleTheme object. 120 * Sets the author of the PurpleTheme object.
121 * 121 *
122 * @param theme The purple theme. 122 * @theme: The purple theme.
123 * @param author The author of the PurpleTheme object. 123 * @author: The author of the PurpleTheme object.
124 */ 124 */
125 void purple_theme_set_author(PurpleTheme *theme, const gchar *author); 125 void purple_theme_set_author(PurpleTheme *theme, const gchar *author);
126 126
127 /** 127 /**
128 * Returns the type (string) of the PurpleTheme object. 128 * Returns the type (string) of the PurpleTheme object.
129 * 129 *
130 * @param theme The purple theme. 130 * @theme: The purple theme.
131 * 131 *
132 * @return The string representing the type. 132 * Returns: The string representing the type.
133 */ 133 */
134 const gchar *purple_theme_get_type_string(PurpleTheme *theme); 134 const gchar *purple_theme_get_type_string(PurpleTheme *theme);
135 135
136 /** 136 /**
137 * Returns the directory of the PurpleTheme object. 137 * Returns the directory of the PurpleTheme object.
138 * 138 *
139 * @param theme The purple theme. 139 * @theme: The purple theme.
140 * 140 *
141 * @return The string representing the theme directory. 141 * Returns: The string representing the theme directory.
142 */ 142 */
143 const gchar *purple_theme_get_dir(PurpleTheme *theme); 143 const gchar *purple_theme_get_dir(PurpleTheme *theme);
144 144
145 /** 145 /**
146 * Sets the directory of the PurpleTheme object. 146 * Sets the directory of the PurpleTheme object.
147 * 147 *
148 * @param theme The purple theme. 148 * @theme: The purple theme.
149 * @param dir The directory of the PurpleTheme object. 149 * @dir: The directory of the PurpleTheme object.
150 */ 150 */
151 void purple_theme_set_dir(PurpleTheme *theme, const gchar *dir); 151 void purple_theme_set_dir(PurpleTheme *theme, const gchar *dir);
152 152
153 /** 153 /**
154 * Returns the image preview of the PurpleTheme object. 154 * Returns the image preview of the PurpleTheme object.
155 * 155 *
156 * @param theme The purple theme. 156 * @theme: The purple theme.
157 * 157 *
158 * @return The image preview of the PurpleTheme object. 158 * Returns: The image preview of the PurpleTheme object.
159 */ 159 */
160 const gchar *purple_theme_get_image(PurpleTheme *theme); 160 const gchar *purple_theme_get_image(PurpleTheme *theme);
161 161
162 /** 162 /**
163 * Returns the image preview and directory of the PurpleTheme object. 163 * Returns the image preview and directory of the PurpleTheme object.
164 * 164 *
165 * @param theme The purple theme. 165 * @theme: The purple theme.
166 * 166 *
167 * @return The image preview of the PurpleTheme object. 167 * Returns: The image preview of the PurpleTheme object.
168 */ 168 */
169 gchar *purple_theme_get_image_full(PurpleTheme *theme); 169 gchar *purple_theme_get_image_full(PurpleTheme *theme);
170 170
171 /** 171 /**
172 * Sets the directory of the PurpleTheme object. 172 * Sets the directory of the PurpleTheme object.
173 * 173 *
174 * @param theme The purple theme. 174 * @theme: The purple theme.
175 * @param img The image preview of the PurpleTheme object. 175 * @img: The image preview of the PurpleTheme object.
176 */ 176 */
177 void purple_theme_set_image(PurpleTheme *theme, const gchar *img); 177 void purple_theme_set_image(PurpleTheme *theme, const gchar *img);
178 178
179 G_END_DECLS 179 G_END_DECLS
180 #endif /* PURPLE_THEME_H */ 180 #endif /* PURPLE_THEME_H */

mercurial