1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/Frameworks/libpurple.framework/Versions/0.6.2/Headers/sound-theme.h Fri Aug 21 13:25:11 2009 -0700
1.3 @@ -0,0 +1,108 @@
1.4 +/**
1.5 + * @file sound-theme.h Purple Sound Theme Abstact Class API
1.6 + */
1.7 +
1.8 +/* purple
1.9 + *
1.10 + * Purple is the legal property of its developers, whose names are too numerous
1.11 + * to list here. Please refer to the COPYRIGHT file distributed with this
1.12 + * source distribution.
1.13 + *
1.14 + * This program is free software; you can redistribute it and/or modify
1.15 + * it under the terms of the GNU General Public License as published by
1.16 + * the Free Software Foundation; either version 2 of the License, or
1.17 + * (at your option) any later version.
1.18 + *
1.19 + * This program is distributed in the hope that it will be useful,
1.20 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
1.21 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1.22 + * GNU General Public License for more details.
1.23 + *
1.24 + * You should have received a copy of the GNU General Public License
1.25 + * along with this program; if not, write to the Free Software
1.26 + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
1.27 + */
1.28 +
1.29 +#ifndef PURPLE_SOUND_THEME_H
1.30 +#define PURPLE_SOUND_THEME_H
1.31 +
1.32 +#include <glib.h>
1.33 +#include <glib-object.h>
1.34 +#include "theme.h"
1.35 +#include "sound.h"
1.36 +
1.37 +/**
1.38 + * extends PurpleTheme (theme.h)
1.39 + * A purple sound theme.
1.40 + * This is an object for Purple to represent a sound theme.
1.41 + *
1.42 + * PurpleSoundTheme is a PurpleTheme Object.
1.43 + */
1.44 +typedef struct _PurpleSoundTheme PurpleSoundTheme;
1.45 +typedef struct _PurpleSoundThemeClass PurpleSoundThemeClass;
1.46 +
1.47 +#define PURPLE_TYPE_SOUND_THEME (purple_sound_theme_get_type())
1.48 +#define PURPLE_SOUND_THEME(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_SOUND_THEME, PurpleSoundTheme))
1.49 +#define PURPLE_SOUND_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_SOUND_THEME, PurpleSoundThemeClass))
1.50 +#define PURPLE_IS_SOUND_THEME(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_SOUND_THEME))
1.51 +#define PURPLE_IS_SOUND_THEME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_SOUND_THEME))
1.52 +#define PURPLE_SOUND_THEME_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_SOUND_THEME, PurpleSoundThemeClass))
1.53 +
1.54 +struct _PurpleSoundTheme
1.55 +{
1.56 + PurpleTheme parent;
1.57 + gpointer priv;
1.58 +};
1.59 +
1.60 +struct _PurpleSoundThemeClass
1.61 +{
1.62 + PurpleThemeClass parent_class;
1.63 +};
1.64 +
1.65 +/**************************************************************************/
1.66 +/** @name Purple Sound Theme API */
1.67 +/**************************************************************************/
1.68 +G_BEGIN_DECLS
1.69 +
1.70 +/**
1.71 + * GObject foo.
1.72 + * @internal.
1.73 + */
1.74 +GType purple_sound_theme_get_type(void);
1.75 +
1.76 +/**
1.77 + * Returns a copy of the filename for the sound event.
1.78 + *
1.79 + * @param theme The theme.
1.80 + * @param event The purple sound event to look up.
1.81 + *
1.82 + * @returns The filename of the sound event.
1.83 + */
1.84 +const gchar *purple_sound_theme_get_file(PurpleSoundTheme *theme,
1.85 + const gchar *event);
1.86 +
1.87 +/**
1.88 + * Returns a copy of the directory and filename for the sound event
1.89 + *
1.90 + * @param theme The theme.
1.91 + * @param event The purple sound event to look up
1.92 + *
1.93 + * @returns The directory + '/' + filename of the sound event. This is
1.94 + * a newly allocated string that should be freed with g_free.
1.95 + */
1.96 +gchar *purple_sound_theme_get_file_full(PurpleSoundTheme *theme,
1.97 + const gchar *event);
1.98 +
1.99 +/**
1.100 + * Sets the filename for a given sound event
1.101 + *
1.102 + * @param theme The theme.
1.103 + * @param event the purple sound event to look up
1.104 + * @param filename the name of the file to be used for the event
1.105 + */
1.106 +void purple_sound_theme_set_file(PurpleSoundTheme *theme,
1.107 + const gchar *event,
1.108 + const gchar *filename);
1.109 +
1.110 +G_END_DECLS
1.111 +#endif /* PURPLE_SOUND_THEME_H */