]> Pileus Git - ~andy/gtk/blob - gtk/gtkfontsel.h
Fix ZWJ => ZWN typo. (#83092, Tino Meinen)
[~andy/gtk] / gtk / gtkfontsel.h
1 /* GTK - The GIMP 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 #ifndef __GTK_FONTSEL_H__
32 #define __GTK_FONTSEL_H__
33
34
35 #include <gdk/gdk.h>
36 #include <gtk/gtkdialog.h>
37 #include <gtk/gtkvbox.h>
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif /* __cplusplus */
42
43 #define GTK_TYPE_FONT_SELECTION              (gtk_font_selection_get_type ())
44 #define GTK_FONT_SELECTION(obj)              (GTK_CHECK_CAST ((obj), GTK_TYPE_FONT_SELECTION, GtkFontSelection))
45 #define GTK_FONT_SELECTION_CLASS(klass)      (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_FONT_SELECTION, GtkFontSelectionClass))
46 #define GTK_IS_FONT_SELECTION(obj)           (GTK_CHECK_TYPE ((obj), GTK_TYPE_FONT_SELECTION))
47 #define GTK_IS_FONT_SELECTION_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FONT_SELECTION))
48 #define GTK_FONT_SELECTION_GET_CLASS(obj)    (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_FONT_SELECTION, GtkFontSelectionClass))
49
50
51 #define GTK_TYPE_FONT_SELECTION_DIALOG              (gtk_font_selection_dialog_get_type ())
52 #define GTK_FONT_SELECTION_DIALOG(obj)              (GTK_CHECK_CAST ((obj), GTK_TYPE_FONT_SELECTION_DIALOG, GtkFontSelectionDialog))
53 #define GTK_FONT_SELECTION_DIALOG_CLASS(klass)      (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_FONT_SELECTION_DIALOG, GtkFontSelectionDialogClass))
54 #define GTK_IS_FONT_SELECTION_DIALOG(obj)           (GTK_CHECK_TYPE ((obj), GTK_TYPE_FONT_SELECTION_DIALOG))
55 #define GTK_IS_FONT_SELECTION_DIALOG_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FONT_SELECTION_DIALOG))
56 #define GTK_FONT_SELECTION_DIALOG_GET_CLASS(obj)    (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_FONT_SELECTION_DIALOG, GtkFontSelectionDialogClass))
57
58
59 typedef struct _GtkFontSelection             GtkFontSelection;
60 typedef struct _GtkFontSelectionClass        GtkFontSelectionClass;
61
62 typedef struct _GtkFontSelectionDialog       GtkFontSelectionDialog;
63 typedef struct _GtkFontSelectionDialogClass  GtkFontSelectionDialogClass;
64
65 struct _GtkFontSelection
66 {
67   GtkVBox parent_instance;
68   
69   GtkWidget *font_entry;
70   GtkWidget *family_list;
71   GtkWidget *font_style_entry;
72   GtkWidget *face_list;
73   GtkWidget *size_entry;
74   GtkWidget *size_list;
75   GtkWidget *pixels_button;
76   GtkWidget *points_button;
77   GtkWidget *filter_button;
78   GtkWidget *preview_entry;
79
80   PangoFontFamily *family;      /* Current family */
81   PangoFontFace *face;          /* Current face */
82   
83   gint size;
84   
85   GdkFont *font;                /* Cache for gdk_font_selection_get_font, so we can preserve
86                                  * refcounting behavior
87                                  */
88 };
89
90 struct _GtkFontSelectionClass
91 {
92   GtkVBoxClass parent_class;
93
94   /* Padding for future expansion */
95   void (*_gtk_reserved1) (void);
96   void (*_gtk_reserved2) (void);
97   void (*_gtk_reserved3) (void);
98   void (*_gtk_reserved4) (void);
99 };
100
101
102 struct _GtkFontSelectionDialog
103 {
104   GtkDialog parent_instance;
105   
106   GtkWidget *fontsel;
107   
108   GtkWidget *main_vbox;
109   GtkWidget *action_area;
110   GtkWidget *ok_button;
111   /* The 'Apply' button is not shown by default but you can show/hide it. */
112   GtkWidget *apply_button;
113   GtkWidget *cancel_button;
114   
115   /* If the user changes the width of the dialog, we turn auto-shrink off. */
116   gint dialog_width;
117   gboolean auto_resize;
118 };
119
120 struct _GtkFontSelectionDialogClass
121 {
122   GtkDialogClass parent_class;
123
124   /* Padding for future expansion */
125   void (*_gtk_reserved1) (void);
126   void (*_gtk_reserved2) (void);
127   void (*_gtk_reserved3) (void);
128   void (*_gtk_reserved4) (void);
129 };
130
131
132
133 /*****************************************************************************
134  * GtkFontSelection functions.
135  *   see the comments in the GtkFontSelectionDialog functions.
136  *****************************************************************************/
137
138 GtkType    gtk_font_selection_get_type          (void) G_GNUC_CONST;
139 GtkWidget* gtk_font_selection_new               (void);
140 gchar*     gtk_font_selection_get_font_name     (GtkFontSelection *fontsel);
141
142 #ifndef GTK_DISABLE_DEPRECATED
143 GdkFont*   gtk_font_selection_get_font          (GtkFontSelection *fontsel);
144 #endif /* GTK_DISABLE_DEPRECATED */
145
146 gboolean              gtk_font_selection_set_font_name    (GtkFontSelection *fontsel,
147                                                            const gchar      *fontname);
148 G_CONST_RETURN gchar* gtk_font_selection_get_preview_text (GtkFontSelection *fontsel);
149 void                  gtk_font_selection_set_preview_text (GtkFontSelection *fontsel,
150                                                            const gchar      *text);
151
152 /*****************************************************************************
153  * GtkFontSelectionDialog functions.
154  *   most of these functions simply call the corresponding function in the
155  *   GtkFontSelection.
156  *****************************************************************************/
157
158 GtkType    gtk_font_selection_dialog_get_type   (void) G_GNUC_CONST;
159 GtkWidget* gtk_font_selection_dialog_new        (const gchar      *title);
160
161 /* This returns the X Logical Font Description fontname, or NULL if no font
162    is selected. Note that there is a slight possibility that the font might not
163    have been loaded OK. You should call gtk_font_selection_dialog_get_font()
164    to see if it has been loaded OK.
165    You should g_free() the returned font name after you're done with it. */
166 gchar*   gtk_font_selection_dialog_get_font_name    (GtkFontSelectionDialog *fsd);
167
168 #ifndef GTK_DISABLE_DEPRECATED
169 /* This will return the current GdkFont, or NULL if none is selected or there
170    was a problem loading it. Remember to use gdk_font_ref/unref() if you want
171    to use the font (in a style, for example). */
172 GdkFont* gtk_font_selection_dialog_get_font         (GtkFontSelectionDialog *fsd);
173 #endif /* GTK_DISABLE_DEPRECATED */
174
175 /* This sets the currently displayed font. It should be a valid X Logical
176    Font Description font name (anything else will be ignored), e.g.
177    "-adobe-courier-bold-o-normal--25-*-*-*-*-*-*-*" 
178    It returns TRUE on success. */
179 gboolean gtk_font_selection_dialog_set_font_name    (GtkFontSelectionDialog *fsd,
180                                                      const gchar        *fontname);
181
182 /* This returns the text in the preview entry. You should copy the returned
183    text if you need it. */
184 G_CONST_RETURN gchar* gtk_font_selection_dialog_get_preview_text (GtkFontSelectionDialog *fsd);
185
186 /* This sets the text in the preview entry. It will be copied by the entry,
187    so there's no need to g_strdup() it first. */
188 void     gtk_font_selection_dialog_set_preview_text (GtkFontSelectionDialog *fsd,
189                                                      const gchar            *text);
190
191
192 #ifdef __cplusplus
193 }
194 #endif /* __cplusplus */
195
196
197 #endif /* __GTK_FONTSEL_H__ */