]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkfontchooser.h
GtkTextView: don't popdown a bubble if we don't have one
[~andy/gtk] / gtk / gtkfontchooser.h
index 718f822b8a4accc49ba532330ad2fe655aac8a8e..1c1bbf09b17ba602eb7ce9b2efbec22226293b28 100644 (file)
@@ -1,10 +1,8 @@
 /* GTK - The GIMP Toolkit
- * Copyright (C) 2011      Alberto Ruiz <aruiz@gnome.org>
- * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
+ * gtkfontchooser.h - Abstract interface for font file selectors GUIs
  *
- * GtkFontChooser widget for Gtk+, by Damon Chaplin, May 1998.
- * Based on the GnomeFontSelector widget, by Elliot Lee, but major changes.
- * The GnomeFontSelector was derived from app/text_tool.c in the GIMP.
+ * Copyright (C) 2006, Emmanuele Bassi
+ * Copyright (C) 2011 Alberto Ruiz <aruiz@gnome.org>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the GNU
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
-#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
-#error "Only <gtk/gtk.h> can be included directly."
-#endif
-
 #ifndef __GTK_FONT_CHOOSER_H__
 #define __GTK_FONT_CHOOSER_H__
 
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
 
-#include <gtk/gtkdialog.h>
-#include <gtk/gtkvbox.h>
-
+#include <gtk/gtkwidget.h>
 
 G_BEGIN_DECLS
 
-#define GTK_TYPE_FONT_CHOOSER              (gtk_font_chooser_get_type ())
-#define GTK_FONT_CHOOSER(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FONT_CHOOSER, GtkFontChooser))
-#define GTK_FONT_CHOOSER_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FONT_CHOOSER, GtkFontChooserClass))
-#define GTK_IS_FONT_CHOOSER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FONT_CHOOSER))
-#define GTK_IS_FONT_CHOOSER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FONT_CHOOSER))
-#define GTK_FONT_CHOOSER_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FONT_CHOOSER, GtkFontChooserClass))
-
-
-#define GTK_TYPE_FONT_CHOOSER_DIALOG              (gtk_font_chooser_dialog_get_type ())
-#define GTK_FONT_CHOOSER_DIALOG(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FONT_CHOOSER_DIALOG, GtkFontChooserDialog))
-#define GTK_FONT_CHOOSER_DIALOG_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FONT_CHOOSER_DIALOG, GtkFontChooserDialogClass))
-#define GTK_IS_FONT_CHOOSER_DIALOG(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FONT_CHOOSER_DIALOG))
-#define GTK_IS_FONT_CHOOSER_DIALOG_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FONT_CHOOSER_DIALOG))
-#define GTK_FONT_CHOOSER_DIALOG_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FONT_CHOOSER_DIALOG, GtkFontChooserDialogClass))
-
-
-typedef struct _GtkFontChooser              GtkFontChooser;
-typedef struct _GtkFontChooserPrivate       GtkFontChooserPrivate;
-typedef struct _GtkFontChooserClass         GtkFontChooserClass;
-
-typedef struct _GtkFontChooserDialog              GtkFontChooserDialog;
-typedef struct _GtkFontChooserDialogPrivate       GtkFontChooserDialogPrivate;
-typedef struct _GtkFontChooserDialogClass         GtkFontChooserDialogClass;
+/**
+ * GtkFontFilterFunc:
+ * @family: a #PangoFontFamily
+ * @face: a #PangoFontFace belonging to @family
+ * @data: (closure): user data passed to gtk_font_chooser_set_filter_func()
+ *
+ * The type of function that is used for deciding what fonts get
+ * shown in a #GtkFontChooser. See gtk_font_chooser_set_filter_func().
+ *
+ * Returns: %TRUE if the font should be displayed
+ */
+typedef gboolean (*GtkFontFilterFunc) (const PangoFontFamily *family,
+                                       const PangoFontFace   *face,
+                                       gpointer               data);
 
-struct _GtkFontChooser
-{
-  GtkVBox parent_instance;
+#define GTK_TYPE_FONT_CHOOSER                  (gtk_font_chooser_get_type ())
+#define GTK_FONT_CHOOSER(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FONT_CHOOSER, GtkFontChooser))
+#define GTK_IS_FONT_CHOOSER(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FONT_CHOOSER))
+#define GTK_FONT_CHOOSER_GET_IFACE(inst)       (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GTK_TYPE_FONT_CHOOSER, GtkFontChooserIface))
 
-  /*< private >*/
-  GtkFontChooserPrivate *priv;
-};
+typedef struct _GtkFontChooser      GtkFontChooser; /* dummy */
+typedef struct _GtkFontChooserIface GtkFontChooserIface;
 
-struct _GtkFontChooserClass
+struct _GtkFontChooserIface
 {
-  GtkVBoxClass parent_class;
+  GTypeInterface base_iface;
 
-  /* Padding for future expansion */
-  void (*_gtk_reserved1) (void);
-  void (*_gtk_reserved2) (void);
-  void (*_gtk_reserved3) (void);
-  void (*_gtk_reserved4) (void);
-};
+  /* Methods */
+  PangoFontFamily * (* get_font_family)         (GtkFontChooser  *fontchooser);
+  PangoFontFace *   (* get_font_face)           (GtkFontChooser  *fontchooser);
+  gint              (* get_font_size)           (GtkFontChooser  *fontchooser);
 
+  void              (* set_filter_func)         (GtkFontChooser   *fontchooser,
+                                                 GtkFontFilterFunc filter,
+                                                 gpointer          user_data,
+                                                 GDestroyNotify    destroy);
 
-struct _GtkFontChooserDialog
-{
-  GtkDialog parent_instance;
+  /* Signals */
+  void (* font_activated) (GtkFontChooser *chooser,
+                           const gchar    *fontname);
 
-  /*< private >*/
-  GtkFontChooserDialogPrivate *priv;
+   /* Padding */
+  gpointer padding[12];
 };
 
-struct _GtkFontChooserDialogClass
-{
-  GtkDialogClass parent_class;
-
-  /* Padding for future expansion */
-  void (*_gtk_reserved1) (void);
-  void (*_gtk_reserved2) (void);
-  void (*_gtk_reserved3) (void);
-  void (*_gtk_reserved4) (void);
-};
-
-
-
-/*****************************************************************************
- * GtkFontChooser functions.
- *   see the comments in the GtkFontChooserDialog functions.
- *****************************************************************************/
-
-GType        gtk_font_chooser_get_type                 (void) G_GNUC_CONST;
-GtkWidget*   gtk_font_chooser_new                      (void);
-PangoFontFamily*
-             gtk_font_chooser_get_family               (GtkFontChooser *fontchooser);
-PangoFontFace*
-             gtk_font_chooser_get_face                 (GtkFontChooser *fontchooser);
-gint         gtk_font_chooser_get_size                 (GtkFontChooser *fontchooser);
-gchar*       gtk_font_chooser_get_font_name            (GtkFontChooser *fontchooser);
-
-gboolean     gtk_font_chooser_set_font_name            (GtkFontChooser *fontchooser,
-                                                        const gchar    *fontname);
-const gchar* gtk_font_chooser_get_preview_text         (GtkFontChooser *fontchooser);
-void         gtk_font_chooser_set_preview_text         (GtkFontChooser *fontchooser,
-                                                        const gchar    *text);
-gboolean     gtk_font_chooser_get_show_preview_entry   (GtkFontChooser *fontchooser);
-void         gtk_font_chooser_set_show_preview_entry   (GtkFontChooser *fontchooser,
-                                                        gboolean        show_preview_entry);
-/*****************************************************************************
- * GtkFontChooserDialog functions.
- *   most of these functions simply call the corresponding function in the
- *   GtkFontChooser.
- *****************************************************************************/
-
-GType       gtk_font_chooser_dialog_get_type         (void) G_GNUC_CONST;
-GtkWidget* gtk_font_chooser_dialog_new             (const gchar            *title);
-
-GtkWidget* gtk_font_chooser_dialog_get_font_selection (GtkFontChooserDialog *fcd);
-
-/* This returns the X Logical Font Description fontname, or NULL if no font
-   is selected. Note that there is a slight possibility that the font might not
-   have been loaded OK. You should call gtk_font_chooser_dialog_get_font()
-   to see if it has been loaded OK.
-   You should g_free() the returned font name after you're done with it. */
-gchar*     gtk_font_chooser_dialog_get_font_name     (GtkFontChooserDialog *fcd);
-
-/* This sets the currently displayed font. It should be a valid X Logical
-   Font Description font name (anything else will be ignored), e.g.
-   "-adobe-courier-bold-o-normal--25-*-*-*-*-*-*-*" 
-   It returns TRUE on success. */
-gboolean   gtk_font_chooser_dialog_set_font_name     (GtkFontChooserDialog *fcd,
-                                                      const gchar          *fontname);
-
-/* This returns the text in the preview entry. You should copy the returned
-   text if you need it. */
-G_CONST_RETURN gchar* 
-          gtk_font_chooser_dialog_get_preview_text   (GtkFontChooserDialog *fcd);
-
-/* This sets the text in the preview entry. It will be copied by the entry,
-   so there's no need to g_strdup() it first. */
-void     gtk_font_chooser_dialog_set_preview_text   (GtkFontChooserDialog *fcd,
-                                                    const gchar                 *text);
+GDK_AVAILABLE_IN_3_2
+GType            gtk_font_chooser_get_type                 (void) G_GNUC_CONST;
+
+GDK_AVAILABLE_IN_3_2
+PangoFontFamily *gtk_font_chooser_get_font_family          (GtkFontChooser   *fontchooser);
+GDK_AVAILABLE_IN_3_2
+PangoFontFace   *gtk_font_chooser_get_font_face            (GtkFontChooser   *fontchooser);
+GDK_AVAILABLE_IN_3_2
+gint             gtk_font_chooser_get_font_size            (GtkFontChooser   *fontchooser);
+
+GDK_AVAILABLE_IN_3_2
+PangoFontDescription *
+                 gtk_font_chooser_get_font_desc            (GtkFontChooser             *fontchooser);
+GDK_AVAILABLE_IN_3_2
+void             gtk_font_chooser_set_font_desc            (GtkFontChooser             *fontchooser,
+                                                            const PangoFontDescription *font_desc);
+
+GDK_AVAILABLE_IN_3_2
+gchar*           gtk_font_chooser_get_font                 (GtkFontChooser   *fontchooser);
+
+GDK_AVAILABLE_IN_3_2
+void             gtk_font_chooser_set_font                 (GtkFontChooser   *fontchooser,
+                                                            const gchar      *fontname);
+GDK_AVAILABLE_IN_3_2
+gchar*           gtk_font_chooser_get_preview_text         (GtkFontChooser   *fontchooser);
+GDK_AVAILABLE_IN_3_2
+void             gtk_font_chooser_set_preview_text         (GtkFontChooser   *fontchooser,
+                                                            const gchar      *text);
+GDK_AVAILABLE_IN_3_2
+gboolean         gtk_font_chooser_get_show_preview_entry   (GtkFontChooser   *fontchooser);
+GDK_AVAILABLE_IN_3_2
+void             gtk_font_chooser_set_show_preview_entry   (GtkFontChooser   *fontchooser,
+                                                            gboolean          show_preview_entry);
+GDK_AVAILABLE_IN_3_2
+void             gtk_font_chooser_set_filter_func          (GtkFontChooser   *fontchooser,
+                                                            GtkFontFilterFunc filter,
+                                                            gpointer          user_data,
+                                                            GDestroyNotify    destroy);
 
 G_END_DECLS
 
-
-#endif /* __GTK_FONTSEL_H__ */
+#endif /* __GTK_FONT_CHOOSER_H__ */