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

   1 /* GTK - The GTK+ Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * GtkFontSelection widget for Gtk+, by Damon Chaplin, May 1998.
   5  * Based on the GnomeFontSelector widget, by Elliot Lee, but major changes.
   6  * The GnomeFontSelector was derived from app/text_tool.c in the GIMP.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /*
  25  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  26  * file for a list of people on the GTK+ Team.  See the ChangeLog
  27  * files for a list of changes.  These files are distributed with
  28  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  29  */
  30
  31 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  32 #error "Only <gtk/gtk.h> can be included directly."
  33 #endif
  34
  35 #ifndef __GTK_FONTSEL_H__
  36 #define __GTK_FONTSEL_H__
  37
  38
  39 #include <gdk/gdk.h>
  40 #include <gtk/gtkdialog.h>
  41 #include <gtk/gtkvbox.h>
  42
  43 G_BEGIN_DECLS
  44
  45 #define GTK_TYPE_FONT_SELECTION              (gtk_font_selection_get_type ())
  46 #define GTK_FONT_SELECTION(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FONT_SELECTION, GtkFontSelection))
  47 #define GTK_FONT_SELECTION_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FONT_SELECTION, GtkFontSelectionClass))
  48 #define GTK_IS_FONT_SELECTION(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FONT_SELECTION))
  49 #define GTK_IS_FONT_SELECTION_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FONT_SELECTION))
  50 #define GTK_FONT_SELECTION_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FONT_SELECTION, GtkFontSelectionClass))
  51
  52
  53 #define GTK_TYPE_FONT_SELECTION_DIALOG              (gtk_font_selection_dialog_get_type ())
  54 #define GTK_FONT_SELECTION_DIALOG(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_FONT_SELECTION_DIALOG, GtkFontSelectionDialog))
  55 #define GTK_FONT_SELECTION_DIALOG_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_FONT_SELECTION_DIALOG, GtkFontSelectionDialogClass))
  56 #define GTK_IS_FONT_SELECTION_DIALOG(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FONT_SELECTION_DIALOG))
  57 #define GTK_IS_FONT_SELECTION_DIALOG_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FONT_SELECTION_DIALOG))
  58 #define GTK_FONT_SELECTION_DIALOG_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FONT_SELECTION_DIALOG, GtkFontSelectionDialogClass))
  59
  60
  61 typedef struct _GtkFontSelection             GtkFontSelection;
  62 typedef struct _GtkFontSelectionClass        GtkFontSelectionClass;
  63
  64 typedef struct _GtkFontSelectionDialog       GtkFontSelectionDialog;
  65 typedef struct _GtkFontSelectionDialogClass  GtkFontSelectionDialogClass;
  66
  67 struct _GtkFontSelection
  68 {
  69   GtkVBox parent_instance;
  70
  71   GtkWidget *GSEAL (font_entry);        /* Used _get_family_entry() for consistency, -mr */
  72   GtkWidget *GSEAL (family_list);
  73   GtkWidget *GSEAL (font_style_entry);  /* Used _get_face_entry() for consistency, -mr */
  74   GtkWidget *GSEAL (face_list);
  75   GtkWidget *GSEAL (size_entry);
  76   GtkWidget *GSEAL (size_list);
  77   GtkWidget *GSEAL (pixels_button);     /* Unused, -mr */
  78   GtkWidget *GSEAL (points_button);     /* Unused, -mr */
  79   GtkWidget *GSEAL (filter_button);     /* Unused, -mr */
  80   GtkWidget *GSEAL (preview_entry);
  81
  82   PangoFontFamily *GSEAL (family);      /* Current family */
  83   PangoFontFace *GSEAL (face);          /* Current face */
  84
  85   gint GSEAL (size);
  86
  87   GdkFont *GSEAL (font);                /* Cache for gdk_font_selection_get_font, so we can preserve
  88                                          * refcounting behavior
  89                                          */
  90 };
  91
  92 struct _GtkFontSelectionClass
  93 {
  94   GtkVBoxClass parent_class;
  95
  96   /* Padding for future expansion */
  97   void (*_gtk_reserved1) (void);
  98   void (*_gtk_reserved2) (void);
  99   void (*_gtk_reserved3) (void);
 100   void (*_gtk_reserved4) (void);
 101 };
 102
 103 struct _GtkFontSelectionDialog
 104 {
 105   GtkDialog parent_instance;
 106
 107   /*< private >*/
 108   GtkWidget *GSEAL (fontsel);
 109
 110   GtkWidget *GSEAL (main_vbox);     /* Not wrapped with an API, can use GTK_DIALOG->vbox instead, -mr */
 111   GtkWidget *GSEAL (action_area);   /* Not wrapped with an API, can use GTK_DIALOG->action_area instead, -mr */
 112
 113   /*< public >*/
 114   GtkWidget *GSEAL (ok_button);
 115   GtkWidget *GSEAL (apply_button);
 116   GtkWidget *GSEAL (cancel_button);
 117
 118   /*< private >*/
 119
 120   /* If the user changes the width of the dialog, we turn auto-shrink off.
 121    * (Unused now, autoshrink doesn't mean anything anymore -Yosh)
 122    */
 123   gint GSEAL (dialog_width);
 124   gboolean GSEAL (auto_resize);
 125 };
 126
 127 struct _GtkFontSelectionDialogClass
 128 {
 129   GtkDialogClass parent_class;
 130
 131   /* Padding for future expansion */
 132   void (*_gtk_reserved1) (void);
 133   void (*_gtk_reserved2) (void);
 134   void (*_gtk_reserved3) (void);
 135   void (*_gtk_reserved4) (void);
 136 };
 137
 138
 139
 140 /*****************************************************************************
 141  * GtkFontSelection functions.
 142  *   see the comments in the GtkFontSelectionDialog functions.
 143  *****************************************************************************/
 144
 145 GType        gtk_font_selection_get_type          (void) G_GNUC_CONST;
 146 GtkWidget *  gtk_font_selection_new               (void);
 147 GtkWidget *  gtk_font_selection_get_family_entry  (GtkFontSelection *fontsel);
 148 GtkWidget *  gtk_font_selection_get_family_list   (GtkFontSelection *fontsel);
 149 GtkWidget *  gtk_font_selection_get_face_entry    (GtkFontSelection *fontsel);
 150 GtkWidget *  gtk_font_selection_get_face_list     (GtkFontSelection *fontsel);
 151 GtkWidget *  gtk_font_selection_get_size_entry    (GtkFontSelection *fontsel);
 152 GtkWidget *  gtk_font_selection_get_size_list     (GtkFontSelection *fontsel);
 153 GtkWidget *  gtk_font_selection_get_preview_entry (GtkFontSelection *fontsel);
 154 PangoFontFamily *
 155              gtk_font_selection_get_family        (GtkFontSelection *fontsel);
 156 PangoFontFace *
 157              gtk_font_selection_get_face          (GtkFontSelection *fontsel);
 158 gint         gtk_font_selection_get_size          (GtkFontSelection *fontsel);
 159 gchar*       gtk_font_selection_get_font_name     (GtkFontSelection *fontsel);
 160
 161 #ifndef GTK_DISABLE_DEPRECATED
 162 GdkFont*     gtk_font_selection_get_font          (GtkFontSelection *fontsel);
 163 #endif /* GTK_DISABLE_DEPRECATED */
 164
 165 gboolean     gtk_font_selection_set_font_name     (GtkFontSelection *fontsel,
 166                                                    const gchar      *fontname);
 167 const gchar* gtk_font_selection_get_preview_text  (GtkFontSelection *fontsel);
 168 void         gtk_font_selection_set_preview_text  (GtkFontSelection *fontsel,
 169                                                    const gchar      *text);
 170
 171 /*****************************************************************************
 172  * GtkFontSelectionDialog functions.
 173  *   most of these functions simply call the corresponding function in the
 174  *   GtkFontSelection.
 175  *****************************************************************************/
 176
 177 GType      gtk_font_selection_dialog_get_type          (void) G_GNUC_CONST;
 178 GtkWidget *gtk_font_selection_dialog_new               (const gchar            *title);
 179
 180 GtkWidget *gtk_font_selection_dialog_get_ok_button     (GtkFontSelectionDialog *fsd);
 181 GtkWidget *gtk_font_selection_dialog_get_apply_button  (GtkFontSelectionDialog *fsd);
 182 GtkWidget *gtk_font_selection_dialog_get_cancel_button (GtkFontSelectionDialog *fsd);
 183
 184 /* This returns the X Logical Font Description fontname, or NULL if no font
 185    is selected. Note that there is a slight possibility that the font might not
 186    have been loaded OK. You should call gtk_font_selection_dialog_get_font()
 187    to see if it has been loaded OK.
 188    You should g_free() the returned font name after you're done with it. */
 189 gchar*     gtk_font_selection_dialog_get_font_name     (GtkFontSelectionDialog *fsd);
 190
 191 #ifndef GTK_DISABLE_DEPRECATED
 192 /* This will return the current GdkFont, or NULL if none is selected or there
 193    was a problem loading it. Remember to use gdk_font_ref/unref() if you want
 194    to use the font (in a style, for example). */
 195 GdkFont*   gtk_font_selection_dialog_get_font          (GtkFontSelectionDialog *fsd);
 196 #endif /* GTK_DISABLE_DEPRECATED */
 197
 198 /* This sets the currently displayed font. It should be a valid X Logical
 199    Font Description font name (anything else will be ignored), e.g.
 200    "-adobe-courier-bold-o-normal--25-*-*-*-*-*-*-*"
 201    It returns TRUE on success. */
 202 gboolean   gtk_font_selection_dialog_set_font_name     (GtkFontSelectionDialog *fsd,
 203                                                         const gchar            *fontname);
 204
 205 /* This returns the text in the preview entry. You should copy the returned
 206    text if you need it. */
 207 G_CONST_RETURN gchar*
 208           gtk_font_selection_dialog_get_preview_text   (GtkFontSelectionDialog *fsd);
 209
 210 /* This sets the text in the preview entry. It will be copied by the entry,
 211    so there's no need to g_strdup() it first. */
 212 void      gtk_font_selection_dialog_set_preview_text   (GtkFontSelectionDialog *fsd,
 213                                                         const gchar            *text);
 214
 215
 216 G_END_DECLS
 217
 218
 219 #endif /* __GTK_FONTSEL_H__ */