]> Pileus Git - ~andy/gtk/blob - gtk/gtkfontchooser.h
GtkFontChooser: Add a ::font-activated signal
[~andy/gtk] / gtk / gtkfontchooser.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 2011      Alberto Ruiz <aruiz@gnome.org>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
22 #endif
23
24 #ifndef __GTK_FONT_CHOOSER_H__
25 #define __GTK_FONT_CHOOSER_H__
26
27 #include <gtk/gtkbox.h>
28
29 G_BEGIN_DECLS
30
31 #define GTK_TYPE_FONT_CHOOSER              (gtk_font_chooser_get_type ())
32 #define GTK_FONT_CHOOSER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FONT_CHOOSER, GtkFontChooser))
33 #define GTK_FONT_CHOOSER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FONT_CHOOSER, GtkFontChooserClass))
34 #define GTK_IS_FONT_CHOOSER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FONT_CHOOSER))
35 #define GTK_IS_FONT_CHOOSER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FONT_CHOOSER))
36 #define GTK_FONT_CHOOSER_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FONT_CHOOSER, GtkFontChooserClass))
37
38 typedef struct _GtkFontChooser              GtkFontChooser;
39 typedef struct _GtkFontChooserPrivate       GtkFontChooserPrivate;
40 typedef struct _GtkFontChooserClass         GtkFontChooserClass;
41
42 struct _GtkFontChooser
43 {
44   GtkBox parent_instance;
45
46   /*< private >*/
47   GtkFontChooserPrivate *priv;
48 };
49
50 struct _GtkFontChooserClass
51 {
52   GtkBoxClass parent_class;
53
54   void (* font_activated) (GtkFontChooser *chooser,
55                            const gchar    *fontname);
56
57   /* Padding for future expansion */
58   void (*_gtk_reserved1) (void);
59   void (*_gtk_reserved2) (void);
60   void (*_gtk_reserved3) (void);
61   void (*_gtk_reserved4) (void);
62 };
63
64 /*****************************************************************************
65  * GtkFontChooser functions.
66  *   see the comments in the GtkFontChooserDialog functions.
67  *****************************************************************************/
68
69 GType        gtk_font_chooser_get_type                 (void) G_GNUC_CONST;
70 GtkWidget*   gtk_font_chooser_new                      (void);
71 PangoFontFamily*
72              gtk_font_chooser_get_family               (GtkFontChooser *fontchooser);
73 PangoFontFace*
74              gtk_font_chooser_get_face                 (GtkFontChooser *fontchooser);
75 gint         gtk_font_chooser_get_size                 (GtkFontChooser *fontchooser);
76 gchar*       gtk_font_chooser_get_font_name            (GtkFontChooser *fontchooser);
77
78 gboolean     gtk_font_chooser_set_font_name            (GtkFontChooser *fontchooser,
79                                                         const gchar    *fontname);
80 const gchar* gtk_font_chooser_get_preview_text         (GtkFontChooser *fontchooser);
81 void         gtk_font_chooser_set_preview_text         (GtkFontChooser *fontchooser,
82                                                         const gchar    *text);
83 gboolean     gtk_font_chooser_get_show_preview_entry   (GtkFontChooser *fontchooser);
84 void         gtk_font_chooser_set_show_preview_entry   (GtkFontChooser *fontchooser,
85                                                         gboolean        show_preview_entry);
86
87 /**
88  * GtkFontFilterFunc:
89  * @family: a #PangoFontFamily
90  * @face: a #PangoFontFace belonging to @family
91  * @data (closure): user data passed to gtk_font_chooser_set_filter_func()
92  *
93  * The type of function that is used for deciding what fonts get
94  * shown in a #GtkFontChooser. See gtk_font_chooser_set_filter_func().
95  *
96  * Returns: %TRUE if the font should be displayed
97  */
98 typedef gboolean (*GtkFontFilterFunc) (const PangoFontFamily *family,
99                                        const PangoFontFace   *face,
100                                        gpointer               data);
101
102 void         gtk_font_chooser_set_filter_func (GtkFontChooser   *fontchooser,
103                                                GtkFontFilterFunc filter,
104                                                gpointer          data,
105                                                GDestroyNotify    destroy);
106
107 G_END_DECLS
108
109 #endif /* __GTK_FONT_CHOOSER_H__ */