pidgin 2.14.14dev
gtkblist-theme.h File Reference

GTK+ Buddy List Theme API. More...

#include <glib.h>
#include <glib-object.h>
#include <gtk/gtk.h>
#include "theme.h"
Include dependency graph for gtkblist-theme.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _PidginBlistTheme
 
struct  _PidginBlistThemeClass
 
struct  PidginBlistLayout
 

Macros

#define PIDGIN_TYPE_BLIST_THEME   (pidgin_blist_theme_get_type ())
 
#define PIDGIN_BLIST_THEME(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistTheme))
 
#define PIDGIN_BLIST_THEME_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass))
 
#define PIDGIN_IS_BLIST_THEME(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PIDGIN_TYPE_BLIST_THEME))
 
#define PIDGIN_IS_BLIST_THEME_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_BLIST_THEME))
 
#define PIDGIN_BLIST_THEME_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass))
 

Typedefs

typedef struct _PidginBlistTheme PidginBlistTheme
 A pidgin buddy list theme. More...
 
typedef struct _PidginBlistThemeClass PidginBlistThemeClass
 
typedef struct _PidginThemeFont PidginThemeFont
 

Functions

PidginThemeFont API <br>
PidginThemeFont * pidgin_theme_font_new (const gchar *face, GdkColor *color)
 Create a new PidginThemeFont. More...
 
void pidgin_theme_font_free (PidginThemeFont *font)
 Frees a font and color pair. More...
 
void pidgin_theme_font_set_font_face (PidginThemeFont *font, const gchar *face)
 Set the font-face of a PidginThemeFont. More...
 
void pidgin_theme_font_set_color (PidginThemeFont *font, const GdkColor *color)
 Set the color of a PidginThemeFont. More...
 
const gchar * pidgin_theme_font_get_font_face (PidginThemeFont *font)
 Get the font-face of a PidginThemeFont. More...
 
const GdkColor * pidgin_theme_font_get_color (PidginThemeFont *font)
 Get the color of a PidginThemeFont as a GdkColor object. More...
 
const gchar * pidgin_theme_font_get_color_describe (PidginThemeFont *font)
 Get the color of a PidginThemeFont. More...
 
Purple Buddy List Theme API <br>
G_BEGIN_DECLS GType pidgin_blist_theme_get_type (void)
 GObject foo.
 
GdkColor * pidgin_blist_theme_get_background_color (PidginBlistTheme *theme)
 Returns the background color of the buddy list. More...
 
gdouble pidgin_blist_theme_get_opacity (PidginBlistTheme *theme)
 Returns the opacity of the buddy list window (0.0 or clear to 1.0 fully opaque). More...
 
PidginBlistLayoutpidgin_blist_theme_get_layout (PidginBlistTheme *theme)
 Returns the layout to be used with the buddy list. More...
 
GdkColor * pidgin_blist_theme_get_expanded_background_color (PidginBlistTheme *theme)
 Returns the background color to be used with expanded groups. More...
 
PidginThemeFont * pidgin_blist_theme_get_expanded_text_info (PidginBlistTheme *theme)
 Returns the text font and color to be used with expanded groups. More...
 
GdkColor * pidgin_blist_theme_get_collapsed_background_color (PidginBlistTheme *theme)
 Returns the background color to be used with collapsed groups. More...
 
PidginThemeFont * pidgin_blist_theme_get_collapsed_text_info (PidginBlistTheme *theme)
 Returns the text font and color to be used with collapsed groups. More...
 
GdkColor * pidgin_blist_theme_get_contact_color (PidginBlistTheme *theme)
 Returns the colors to be used for contacts and chats. More...
 
PidginThemeFont * pidgin_blist_theme_get_contact_text_info (PidginBlistTheme *theme)
 Returns the text font and color to be used for expanded contacts. More...
 
PidginThemeFont * pidgin_blist_theme_get_online_text_info (PidginBlistTheme *theme)
 Returns the text font and color to be used for online buddies. More...
 
PidginThemeFont * pidgin_blist_theme_get_away_text_info (PidginBlistTheme *theme)
 Returns the text font and color to be used for away and idle buddies. More...
 
PidginThemeFont * pidgin_blist_theme_get_offline_text_info (PidginBlistTheme *theme)
 Returns the text font and color to be used for offline buddies. More...
 
PidginThemeFont * pidgin_blist_theme_get_idle_text_info (PidginBlistTheme *theme)
 Returns the text font and color to be used for idle buddies. More...
 
PidginThemeFont * pidgin_blist_theme_get_unread_message_text_info (PidginBlistTheme *theme)
 Returns the text font and color to be used for buddies with unread messages. More...
 
PidginThemeFont * pidgin_blist_theme_get_unread_message_nick_said_text_info (PidginBlistTheme *theme)
 Returns the text font and color to be used for chats with unread messages that mention your nick. More...
 
PidginThemeFont * pidgin_blist_theme_get_status_text_info (PidginBlistTheme *theme)
 Returns the text font and color to be used for a buddy's status message. More...
 
void pidgin_blist_theme_set_background_color (PidginBlistTheme *theme, const GdkColor *color)
 Sets the background color to be used for this buddy list theme. More...
 
void pidgin_blist_theme_set_opacity (PidginBlistTheme *theme, gdouble opacity)
 Sets the opacity to be used for this buddy list theme. More...
 
void pidgin_blist_theme_set_layout (PidginBlistTheme *theme, const PidginBlistLayout *layout)
 Sets the buddy list layout to be used for this buddy list theme. More...
 
void pidgin_blist_theme_set_expanded_background_color (PidginBlistTheme *theme, const GdkColor *color)
 Sets the background color to be used for expanded groups. More...
 
void pidgin_blist_theme_set_expanded_text_info (PidginBlistTheme *theme, const PidginThemeFont *pair)
 Sets the text color and font to be used for expanded groups. More...
 
void pidgin_blist_theme_set_collapsed_background_color (PidginBlistTheme *theme, const GdkColor *color)
 Sets the background color to be used for collapsed groups. More...
 
void pidgin_blist_theme_set_collapsed_text_info (PidginBlistTheme *theme, const PidginThemeFont *pair)
 Sets the text color and font to be used for expanded groups. More...
 
void pidgin_blist_theme_set_contact_color (PidginBlistTheme *theme, const GdkColor *color)
 Sets the background color to be used for contacts and chats. More...
 
void pidgin_blist_theme_set_contact_text_info (PidginBlistTheme *theme, const PidginThemeFont *pair)
 Sets the text color and font to be used for expanded contacts. More...
 
void pidgin_blist_theme_set_online_text_info (PidginBlistTheme *theme, const PidginThemeFont *pair)
 Sets the text color and font to be used for online buddies. More...
 
void pidgin_blist_theme_set_away_text_info (PidginBlistTheme *theme, const PidginThemeFont *pair)
 Sets the text color and font to be used for away and idle buddies. More...
 
void pidgin_blist_theme_set_offline_text_info (PidginBlistTheme *theme, const PidginThemeFont *pair)
 Sets the text color and font to be used for offline buddies. More...
 
void pidgin_blist_theme_set_idle_text_info (PidginBlistTheme *theme, const PidginThemeFont *pair)
 Sets the text color and font to be used for idle buddies. More...
 
void pidgin_blist_theme_set_unread_message_text_info (PidginBlistTheme *theme, const PidginThemeFont *pair)
 Sets the text color and font to be used for buddies with unread messages. More...
 
void pidgin_blist_theme_set_unread_message_nick_said_text_info (PidginBlistTheme *theme, const PidginThemeFont *pair)
 Sets the text color and font to be used for a chat with unread messages that mention your nick. More...
 
void pidgin_blist_theme_set_status_text_info (PidginBlistTheme *theme, const PidginThemeFont *pair)
 Sets the text color and font to be used for buddy status messages. More...
 

Detailed Description

GTK+ Buddy List Theme API.

Definition in file gtkblist-theme.h.

Macro Definition Documentation

◆ PIDGIN_BLIST_THEME

#define PIDGIN_BLIST_THEME (   obj)    (G_TYPE_CHECK_INSTANCE_CAST ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistTheme))

Definition at line 45 of file gtkblist-theme.h.

◆ PIDGIN_BLIST_THEME_CLASS

#define PIDGIN_BLIST_THEME_CLASS (   klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass))

Definition at line 46 of file gtkblist-theme.h.

◆ PIDGIN_BLIST_THEME_GET_CLASS

#define PIDGIN_BLIST_THEME_GET_CLASS (   obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), PIDGIN_TYPE_BLIST_THEME, PidginBlistThemeClass))

Definition at line 49 of file gtkblist-theme.h.

◆ PIDGIN_IS_BLIST_THEME

#define PIDGIN_IS_BLIST_THEME (   obj)    (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PIDGIN_TYPE_BLIST_THEME))

Definition at line 47 of file gtkblist-theme.h.

◆ PIDGIN_IS_BLIST_THEME_CLASS

#define PIDGIN_IS_BLIST_THEME_CLASS (   klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), PIDGIN_TYPE_BLIST_THEME))

Definition at line 48 of file gtkblist-theme.h.

◆ PIDGIN_TYPE_BLIST_THEME

#define PIDGIN_TYPE_BLIST_THEME   (pidgin_blist_theme_get_type ())

Definition at line 44 of file gtkblist-theme.h.

Typedef Documentation

◆ PidginBlistTheme

A pidgin buddy list theme.

This is an object for Purple to represent a buddy list theme.

PidginBlistTheme is a PurpleTheme Object.

Definition at line 41 of file gtkblist-theme.h.

◆ PidginBlistThemeClass

Definition at line 42 of file gtkblist-theme.h.

◆ PidginThemeFont

typedef struct _PidginThemeFont PidginThemeFont

Definition at line 70 of file gtkblist-theme.h.

Function Documentation

◆ pidgin_blist_theme_get_away_text_info()

PidginThemeFont * pidgin_blist_theme_get_away_text_info ( PidginBlistTheme theme)

Returns the text font and color to be used for away and idle buddies.

Parameters
themeThe PidginBlist theme.
Returns
A font and color pair.

◆ pidgin_blist_theme_get_background_color()

GdkColor * pidgin_blist_theme_get_background_color ( PidginBlistTheme theme)

Returns the background color of the buddy list.

Parameters
themeThe PidginBlist theme.
Returns
A gdk color.

◆ pidgin_blist_theme_get_collapsed_background_color()

GdkColor * pidgin_blist_theme_get_collapsed_background_color ( PidginBlistTheme theme)

Returns the background color to be used with collapsed groups.

Parameters
themeThe PidginBlist theme.
Returns
A gdk color.

◆ pidgin_blist_theme_get_collapsed_text_info()

PidginThemeFont * pidgin_blist_theme_get_collapsed_text_info ( PidginBlistTheme theme)

Returns the text font and color to be used with collapsed groups.

Parameters
themeThe PidginBlist theme.
Returns
A font and color pair.

◆ pidgin_blist_theme_get_contact_color()

GdkColor * pidgin_blist_theme_get_contact_color ( PidginBlistTheme theme)

Returns the colors to be used for contacts and chats.

Parameters
themeThe PidginBlist theme.
Returns
A gdkcolor for contacts and chats.

◆ pidgin_blist_theme_get_contact_text_info()

PidginThemeFont * pidgin_blist_theme_get_contact_text_info ( PidginBlistTheme theme)

Returns the text font and color to be used for expanded contacts.

Parameters
themeThe PidginBlist theme.
Returns
A font and color pair.

◆ pidgin_blist_theme_get_expanded_background_color()

GdkColor * pidgin_blist_theme_get_expanded_background_color ( PidginBlistTheme theme)

Returns the background color to be used with expanded groups.

Parameters
themeThe PidginBlist theme.
Returns
A gdk color.

◆ pidgin_blist_theme_get_expanded_text_info()

PidginThemeFont * pidgin_blist_theme_get_expanded_text_info ( PidginBlistTheme theme)

Returns the text font and color to be used with expanded groups.

Parameters
themeThe PidginBlist theme.
Returns
A font and color pair.

◆ pidgin_blist_theme_get_idle_text_info()

PidginThemeFont * pidgin_blist_theme_get_idle_text_info ( PidginBlistTheme theme)

Returns the text font and color to be used for idle buddies.

Parameters
themeThe PidginBlist theme.
Returns
A font and color pair.

◆ pidgin_blist_theme_get_layout()

PidginBlistLayout * pidgin_blist_theme_get_layout ( PidginBlistTheme theme)

Returns the layout to be used with the buddy list.

Parameters
themeThe PidginBlist theme.
Returns
The buddy list layout.

◆ pidgin_blist_theme_get_offline_text_info()

PidginThemeFont * pidgin_blist_theme_get_offline_text_info ( PidginBlistTheme theme)

Returns the text font and color to be used for offline buddies.

Parameters
themeThe PidginBlist theme.
Returns
A font and color pair.

◆ pidgin_blist_theme_get_online_text_info()

PidginThemeFont * pidgin_blist_theme_get_online_text_info ( PidginBlistTheme theme)

Returns the text font and color to be used for online buddies.

Parameters
themeThe PidginBlist theme.
Returns
A font and color pair.

◆ pidgin_blist_theme_get_opacity()

gdouble pidgin_blist_theme_get_opacity ( PidginBlistTheme theme)

Returns the opacity of the buddy list window (0.0 or clear to 1.0 fully opaque).

Parameters
themeThe PidginBlist theme.
Returns
The opacity

◆ pidgin_blist_theme_get_status_text_info()

PidginThemeFont * pidgin_blist_theme_get_status_text_info ( PidginBlistTheme theme)

Returns the text font and color to be used for a buddy's status message.

Parameters
themeThe PidginBlist theme.
Returns
A font and color pair.

◆ pidgin_blist_theme_get_unread_message_nick_said_text_info()

PidginThemeFont * pidgin_blist_theme_get_unread_message_nick_said_text_info ( PidginBlistTheme theme)

Returns the text font and color to be used for chats with unread messages that mention your nick.

Parameters
themeThe PidginBlist theme.
Returns
A font and color pair.

◆ pidgin_blist_theme_get_unread_message_text_info()

PidginThemeFont * pidgin_blist_theme_get_unread_message_text_info ( PidginBlistTheme theme)

Returns the text font and color to be used for buddies with unread messages.

Parameters
themeThe PidginBlist theme.
Returns
A font and color pair.

◆ pidgin_blist_theme_set_away_text_info()

void pidgin_blist_theme_set_away_text_info ( PidginBlistTheme theme,
const PidginThemeFont *  pair 
)

Sets the text color and font to be used for away and idle buddies.

Parameters
themeThe PidginBlist theme.
pairThe new text font and color pair.

◆ pidgin_blist_theme_set_background_color()

void pidgin_blist_theme_set_background_color ( PidginBlistTheme theme,
const GdkColor *  color 
)

Sets the background color to be used for this buddy list theme.

Parameters
themeThe PidginBlist theme.
colorThe new background color.

◆ pidgin_blist_theme_set_collapsed_background_color()

void pidgin_blist_theme_set_collapsed_background_color ( PidginBlistTheme theme,
const GdkColor *  color 
)

Sets the background color to be used for collapsed groups.

Parameters
themeThe PidginBlist theme.
colorThe new background color.

◆ pidgin_blist_theme_set_collapsed_text_info()

void pidgin_blist_theme_set_collapsed_text_info ( PidginBlistTheme theme,
const PidginThemeFont *  pair 
)

Sets the text color and font to be used for expanded groups.

Parameters
themeThe PidginBlist theme.
pairThe new text font and color pair.

◆ pidgin_blist_theme_set_contact_color()

void pidgin_blist_theme_set_contact_color ( PidginBlistTheme theme,
const GdkColor *  color 
)

Sets the background color to be used for contacts and chats.

Parameters
themeThe PidginBlist theme.
colorThe color to use for contacts and chats.

◆ pidgin_blist_theme_set_contact_text_info()

void pidgin_blist_theme_set_contact_text_info ( PidginBlistTheme theme,
const PidginThemeFont *  pair 
)

Sets the text color and font to be used for expanded contacts.

Parameters
themeThe PidginBlist theme.
pairThe new text font and color pair.

◆ pidgin_blist_theme_set_expanded_background_color()

void pidgin_blist_theme_set_expanded_background_color ( PidginBlistTheme theme,
const GdkColor *  color 
)

Sets the background color to be used for expanded groups.

Parameters
themeThe PidginBlist theme.
colorThe new background color.

◆ pidgin_blist_theme_set_expanded_text_info()

void pidgin_blist_theme_set_expanded_text_info ( PidginBlistTheme theme,
const PidginThemeFont *  pair 
)

Sets the text color and font to be used for expanded groups.

Parameters
themeThe PidginBlist theme.
pairThe new text font and color pair.

◆ pidgin_blist_theme_set_idle_text_info()

void pidgin_blist_theme_set_idle_text_info ( PidginBlistTheme theme,
const PidginThemeFont *  pair 
)

Sets the text color and font to be used for idle buddies.

Parameters
themeThe PidginBlist theme.
pairThe new text font and color pair.

◆ pidgin_blist_theme_set_layout()

void pidgin_blist_theme_set_layout ( PidginBlistTheme theme,
const PidginBlistLayout layout 
)

Sets the buddy list layout to be used for this buddy list theme.

Parameters
themeThe PidginBlist theme.
layoutThe new layout.

◆ pidgin_blist_theme_set_offline_text_info()

void pidgin_blist_theme_set_offline_text_info ( PidginBlistTheme theme,
const PidginThemeFont *  pair 
)

Sets the text color and font to be used for offline buddies.

Parameters
themeThe PidginBlist theme.
pairThe new text font and color pair.

◆ pidgin_blist_theme_set_online_text_info()

void pidgin_blist_theme_set_online_text_info ( PidginBlistTheme theme,
const PidginThemeFont *  pair 
)

Sets the text color and font to be used for online buddies.

Parameters
themeThe PidginBlist theme.
pairThe new text font and color pair.

◆ pidgin_blist_theme_set_opacity()

void pidgin_blist_theme_set_opacity ( PidginBlistTheme theme,
gdouble  opacity 
)

Sets the opacity to be used for this buddy list theme.

Parameters
themeThe PidginBlist theme.
opacityThe new opacity setting.

◆ pidgin_blist_theme_set_status_text_info()

void pidgin_blist_theme_set_status_text_info ( PidginBlistTheme theme,
const PidginThemeFont *  pair 
)

Sets the text color and font to be used for buddy status messages.

Parameters
themeThe PidginBlist theme.
pairThe new text font and color pair.

◆ pidgin_blist_theme_set_unread_message_nick_said_text_info()

void pidgin_blist_theme_set_unread_message_nick_said_text_info ( PidginBlistTheme theme,
const PidginThemeFont *  pair 
)

Sets the text color and font to be used for a chat with unread messages that mention your nick.

Parameters
themeThe PidginBlist theme.
pairThe new text font and color pair.

◆ pidgin_blist_theme_set_unread_message_text_info()

void pidgin_blist_theme_set_unread_message_text_info ( PidginBlistTheme theme,
const PidginThemeFont *  pair 
)

Sets the text color and font to be used for buddies with unread messages.

Parameters
themeThe PidginBlist theme.
pairThe new text font and color pair.

◆ pidgin_theme_font_free()

void pidgin_theme_font_free ( PidginThemeFont *  font)

Frees a font and color pair.

Parameters
fontThe theme font

◆ pidgin_theme_font_get_color()

const GdkColor * pidgin_theme_font_get_color ( PidginThemeFont *  font)

Get the color of a PidginThemeFont as a GdkColor object.

Parameters
fontThe PidginThemeFont
Returns
The color, or NULL if none is set.

◆ pidgin_theme_font_get_color_describe()

const gchar * pidgin_theme_font_get_color_describe ( PidginThemeFont *  font)

Get the color of a PidginThemeFont.

Parameters
fontThe PidginThemeFont
Returns
The color, or NULL if none is set.

◆ pidgin_theme_font_get_font_face()

const gchar * pidgin_theme_font_get_font_face ( PidginThemeFont *  font)

Get the font-face of a PidginThemeFont.

Parameters
fontThe PidginThemeFont
Returns
The font-face, or NULL if none is set.

◆ pidgin_theme_font_new()

PidginThemeFont * pidgin_theme_font_new ( const gchar *  face,
GdkColor *  color 
)

Create a new PidginThemeFont.

Parameters
faceThe font face
colorThe color of the font
Returns
A newly created PidginThemeFont

◆ pidgin_theme_font_set_color()

void pidgin_theme_font_set_color ( PidginThemeFont *  font,
const GdkColor *  color 
)

Set the color of a PidginThemeFont.

Parameters
fontThe PidginThemeFont
colorThe color

◆ pidgin_theme_font_set_font_face()

void pidgin_theme_font_set_font_face ( PidginThemeFont *  font,
const gchar *  face 
)

Set the font-face of a PidginThemeFont.

Parameters
fontThe PidginThemeFont
faceThe font-face