Pileus Git - ~andy/gtk/blob - gtk/gtkfontchooser.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 2011      Alberto Ruiz <aruiz@gnome.org>
   3  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   4  *
   5  * GtkFontSelection widget for Gtk+, by Damon Chaplin, May 1998.
   6  * Based on the GnomeFontSelector widget, by Elliot Lee, but major changes.
   7  * The GnomeFontSelector was derived from app/text_tool.c in the GIMP.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25 /*
  26  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  27  * file for a list of people on the GTK+ Team.  See the ChangeLog
  28  * files for a list of changes.  These files are distributed with
  29  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  30  */
  31
  32 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  33 #error "Only <gtk/gtk.h> can be included directly."
  34 #endif
  35
  36 #ifndef __GTK_FONTSEL_H__
  37 #define __GTK_FONTSEL_H__
  38
  39
  40 #include <gtk/gtkdialog.h>
  41 #include <gtk/gtkvbox.h>
  42
  43
  44 G_BEGIN_DECLS
  45
  46 #define GTK_TYPE_FONT_SELECTION              (gtk_font_selection_get_type ())
  47 #define GTK_FONT_SELECTION(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FONT_SELECTION, GtkFontSelection))
  48 #define GTK_FONT_SELECTION_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FONT_SELECTION, GtkFontSelectionClass))
  49 #define GTK_IS_FONT_SELECTION(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FONT_SELECTION))
  50 #define GTK_IS_FONT_SELECTION_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FONT_SELECTION))
  51 #define GTK_FONT_SELECTION_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FONT_SELECTION, GtkFontSelectionClass))
  52
  53
  54 #define GTK_TYPE_FONT_SELECTION_DIALOG              (gtk_font_selection_dialog_get_type ())
  55 #define GTK_FONT_SELECTION_DIALOG(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FONT_SELECTION_DIALOG, GtkFontSelectionDialog))
  56 #define GTK_FONT_SELECTION_DIALOG_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FONT_SELECTION_DIALOG, GtkFontSelectionDialogClass))
  57 #define GTK_IS_FONT_SELECTION_DIALOG(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FONT_SELECTION_DIALOG))
  58 #define GTK_IS_FONT_SELECTION_DIALOG_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FONT_SELECTION_DIALOG))
  59 #define GTK_FONT_SELECTION_DIALOG_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FONT_SELECTION_DIALOG, GtkFontSelectionDialogClass))
  60
  61
  62 typedef struct _GtkFontSelection              GtkFontSelection;
  63 typedef struct _GtkFontSelectionPrivate       GtkFontSelectionPrivate;
  64 typedef struct _GtkFontSelectionClass         GtkFontSelectionClass;
  65
  66 typedef struct _GtkFontSelectionDialog              GtkFontSelectionDialog;
  67 typedef struct _GtkFontSelectionDialogPrivate       GtkFontSelectionDialogPrivate;
  68 typedef struct _GtkFontSelectionDialogClass         GtkFontSelectionDialogClass;
  69
  70 struct _GtkFontSelection
  71 {
  72   GtkVBox parent_instance;
  73
  74   /*< private >*/
  75   GtkFontSelectionPrivate *priv;
  76 };
  77
  78 struct _GtkFontSelectionClass
  79 {
  80   GtkVBoxClass parent_class;
  81
  82   /* Padding for future expansion */
  83   void (*_gtk_reserved1) (void);
  84   void (*_gtk_reserved2) (void);
  85   void (*_gtk_reserved3) (void);
  86   void (*_gtk_reserved4) (void);
  87 };
  88
  89
  90 struct _GtkFontSelectionDialog
  91 {
  92   GtkDialog parent_instance;
  93
  94   /*< private >*/
  95   GtkFontSelectionDialogPrivate *priv;
  96 };
  97
  98 struct _GtkFontSelectionDialogClass
  99 {
 100   GtkDialogClass parent_class;
 101
 102   /* Padding for future expansion */
 103   void (*_gtk_reserved1) (void);
 104   void (*_gtk_reserved2) (void);
 105   void (*_gtk_reserved3) (void);
 106   void (*_gtk_reserved4) (void);
 107 };
 108
 109
 110
 111 /*****************************************************************************
 112  * GtkFontSelection functions.
 113  *   see the comments in the GtkFontSelectionDialog functions.
 114  *****************************************************************************/
 115
 116 GType        gtk_font_selection_get_type                 (void) G_GNUC_CONST;
 117 GtkWidget*   gtk_font_selection_new                      (void);
 118 PangoFontFamily*
 119              gtk_font_selection_get_family               (GtkFontSelection *fontsel);
 120 PangoFontFace*
 121              gtk_font_selection_get_face                 (GtkFontSelection *fontsel);
 122 gint         gtk_font_selection_get_size                 (GtkFontSelection *fontsel);
 123 gchar*       gtk_font_selection_get_font_name            (GtkFontSelection *fontsel);
 124
 125 gboolean     gtk_font_selection_set_font_name            (GtkFontSelection *fontsel,
 126                                                           const gchar      *fontname);
 127 const gchar* gtk_font_selection_get_preview_text         (GtkFontSelection *fontsel);
 128 void         gtk_font_selection_set_preview_text         (GtkFontSelection *fontsel,
 129                                                           const gchar      *text);
 130 gboolean     gtk_font_selection_get_show_preview_entry   (GtkFontSelection *fontsel);
 131 void         gtk_font_selection_set_show_preview_entry   (GtkFontSelection *fontsel,
 132                                                           gboolean          show_preview_entry);
 133 /* Deprecated GtkFontSelection methods */
 134 #ifndef GTK_DISABLE_DEPRECATED
 135 GtkWidget*  gtk_font_selection_get_family_list   (GtkFontSelection *fontsel);
 136 GtkWidget*  gtk_font_selection_get_face_list     (GtkFontSelection *fontsel);
 137 GtkWidget*  gtk_font_selection_get_size_entry    (GtkFontSelection *fontsel);
 138 GtkWidget*  gtk_font_selection_get_size_list     (GtkFontSelection *fontsel);
 139 GtkWidget*  gtk_font_selection_get_preview_entry (GtkFontSelection *fontsel);
 140 #endif
 141
 142 /*****************************************************************************
 143  * GtkFontSelectionDialog functions.
 144  *   most of these functions simply call the corresponding function in the
 145  *   GtkFontSelection.
 146  *****************************************************************************/
 147
 148 GType      gtk_font_selection_dialog_get_type           (void) G_GNUC_CONST;
 149 GtkWidget* gtk_font_selection_dialog_new                    (const gchar            *title);
 150
 151 GtkWidget* gtk_font_selection_dialog_get_font_selection (GtkFontSelectionDialog *fsd);
 152
 153 /* This returns the X Logical Font Description fontname, or NULL if no font
 154    is selected. Note that there is a slight possibility that the font might not
 155    have been loaded OK. You should call gtk_font_selection_dialog_get_font()
 156    to see if it has been loaded OK.
 157    You should g_free() the returned font name after you're done with it. */
 158 gchar*     gtk_font_selection_dialog_get_font_name     (GtkFontSelectionDialog *fsd);
 159
 160 /* This sets the currently displayed font. It should be a valid X Logical
 161    Font Description font name (anything else will be ignored), e.g.
 162    "-adobe-courier-bold-o-normal--25-*-*-*-*-*-*-*"
 163    It returns TRUE on success. */
 164 gboolean   gtk_font_selection_dialog_set_font_name     (GtkFontSelectionDialog *fsd,
 165                                                         const gchar                *fontname);
 166
 167 /* This returns the text in the preview entry. You should copy the returned
 168    text if you need it. */
 169 G_CONST_RETURN gchar*
 170           gtk_font_selection_dialog_get_preview_text   (GtkFontSelectionDialog *fsd);
 171
 172 /* This sets the text in the preview entry. It will be copied by the entry,
 173    so there's no need to g_strdup() it first. */
 174 void      gtk_font_selection_dialog_set_preview_text   (GtkFontSelectionDialog *fsd,
 175                                                         const gchar                *text);
 176
 177 /* Deprecated GtkFontSelectionDialog methods */
 178 #ifndef GTK_DISABLE_DEPRECATED
 179 GtkWidget* gtk_font_selection_dialog_get_cancel_button  (GtkFontSelectionDialog *fsd);
 180 GtkWidget* gtk_font_selection_dialog_get_ok_button      (GtkFontSelectionDialog *fsd);
 181 #endif
 182
 183 G_END_DECLS
 184
 185
 186 #endif /* __GTK_FONTSEL_H__ */