gtkfontchooser.c 14.2 KB
Newer Older
1
/* GTK - The GIMP Toolkit
2 3 4
 * gtkfontchooser.c - Abstract interface for font file selectors GUIs
 *
 * Copyright (C) 2006, Emmanuele Bassi
5
 * Copyright (C) 2011 Alberto Ruiz <aruiz@gnome.org>
6 7 8 9 10 11 12 13 14 15 16 17
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
18
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19 20 21 22
 */

#include "config.h"

23
#include "gtkfontchooser.h"
24
#include "gtkfontchooserprivate.h"
25
#include "gtkintl.h"
26
#include "gtktypebuiltins.h"
27 28 29
#include "gtkprivate.h"

/**
30
 * SECTION:gtkfontchooser
31
 * @Short_description: Interface implemented by widgets displaying fonts
32
 * @Title: GtkFontChooser
33
 * @See_also: #GtkFontChooserDialog, #GtkFontChooserWidget, #GtkFontButton
34
 *
35
 * #GtkFontChooser is an interface that can be implemented by widgets
36
 * displaying the list of fonts. In GTK+, the main objects
37
 * that implement this interface are #GtkFontChooserWidget,
38 39
 * #GtkFontChooserDialog and #GtkFontButton. The GtkFontChooser interface
 * has been introducted in GTK+ 3.2.
40 41
 */

42
enum
43
{
44
  SIGNAL_FONT_ACTIVATED,
45
  LAST_SIGNAL
46 47
};

48
static guint chooser_signals[LAST_SIGNAL];
49

50 51
typedef GtkFontChooserIface GtkFontChooserInterface;
G_DEFINE_INTERFACE (GtkFontChooser, gtk_font_chooser, G_TYPE_OBJECT);
52 53

static void
54 55
gtk_font_chooser_default_init (GtkFontChooserInterface *iface)
{
56 57 58 59 60
  /**
   * GtkFontChooser:font:
   *
   * The font description as a string, e.g. "Sans Italic 12".
   */
61 62
  g_object_interface_install_property
     (iface,
63 64
      g_param_spec_string ("font",
                          P_("Font"),
65 66 67 68 69 70 71 72 73 74 75 76
                           P_("Font description as a string, e.g. \"Sans Italic 12\""),
                           GTK_FONT_CHOOSER_DEFAULT_FONT_NAME,
                           GTK_PARAM_READWRITE));

  /**
   * GtkFontChooser:font-desc:
   *
   * The font description as a #PangoFontDescription.
   */
  g_object_interface_install_property
     (iface,
      g_param_spec_boxed ("font-desc",
77
                          P_("Font description"),
78 79
                          P_("Font description as a PangoFontDescription struct"),
                          PANGO_TYPE_FONT_DESCRIPTION,
80 81
                          GTK_PARAM_READWRITE));

82 83 84 85 86
  /**
   * GtkFontChooser:preview-text:
   *
   * The string with which to preview the font.
   */
87 88 89 90 91 92 93 94
  g_object_interface_install_property
     (iface,
      g_param_spec_string ("preview-text",
                          P_("Preview text"),
                          P_("The text to display in order to demonstrate the selected font"),
                          pango_language_get_sample_string (NULL),
                          GTK_PARAM_READWRITE));

95 96 97 98 99
  /**
   * GtkFontChooser:show-preview-entry:
   *
   * Whether to show an entry to change the preview text.
   */
100 101 102 103 104 105
  g_object_interface_install_property
     (iface,
      g_param_spec_boolean ("show-preview-entry",
                          P_("Show preview text entry"),
                          P_("Whether the preview text entry is shown or not"),
                          TRUE,
106
                          GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
107

108 109 110 111 112 113 114 115 116 117 118 119
  /**
   * GtkFontChooser:font-map:
   *
   * A custom font map to use for this widget, instead of the
   * default one.
   *
   * Since: 3.18
   */
  g_object_interface_install_property (iface,
      g_param_spec_object ("font-map", P_("Font map"), P_("A custom PangoFontMap"),
                           PANGO_TYPE_FONT_MAP,
                           GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
120
  /**
Matthias Clasen's avatar
Matthias Clasen committed
121
   * GtkFontChooser::font-activated:
122 123 124
   * @self: the object which received the signal
   * @fontname: the font name
   *
Matthias Clasen's avatar
Matthias Clasen committed
125
   * Emitted when a font is activated.
126 127 128
   * This usually happens when the user double clicks an item,
   * or an item is selected and the user presses one of the keys
   * Space, Shift+Space, Return or Enter.
129 130
    */
  chooser_signals[SIGNAL_FONT_ACTIVATED] =
131 132 133
    g_signal_new ("font-activated",
                  GTK_TYPE_FONT_CHOOSER,
                  G_SIGNAL_RUN_FIRST,
134
                  G_STRUCT_OFFSET (GtkFontChooserIface, font_activated),
135 136 137 138
                  NULL, NULL,
                  NULL,
                  G_TYPE_NONE,
                  1, G_TYPE_STRING);
139 140 141
}

/**
142
 * gtk_font_chooser_get_font_family:
143
 * @fontchooser: a #GtkFontChooser
144 145
 *
 * Gets the #PangoFontFamily representing the selected font family.
146
 * Font families are a collection of font faces.
147
 *
148 149
 * If the selected font is not installed, returns %NULL.
 *
150
 * Returns: (transfer none): A #PangoFontFamily representing the
151
 *     selected font family, or %NULL. The returned object is owned by @fontchooser
152
 *     and must not be modified or freed.
153
 *
154
 * Since: 3.2
155 156
 */
PangoFontFamily *
157
gtk_font_chooser_get_font_family (GtkFontChooser *fontchooser)
158
{
159
  g_return_val_if_fail (GTK_IS_FONT_CHOOSER (fontchooser), NULL);
160

161
  return GTK_FONT_CHOOSER_GET_IFACE (fontchooser)->get_font_family (fontchooser);
162 163 164
}

/**
165
 * gtk_font_chooser_get_font_face:
166
 * @fontchooser: a #GtkFontChooser
167 168 169 170
 *
 * Gets the #PangoFontFace representing the selected font group
 * details (i.e. family, slant, weight, width, etc).
 *
171 172
 * If the selected font is not installed, returns %NULL.
 *
173
 * Returns: (transfer none): A #PangoFontFace representing the
174
 *     selected font group details, or %NULL. The returned object is owned by
175
 *     @fontchooser and must not be modified or freed.
176
 *
177
 * Since: 3.2
178 179
 */
PangoFontFace *
180
gtk_font_chooser_get_font_face (GtkFontChooser *fontchooser)
181
{
182
  g_return_val_if_fail (GTK_IS_FONT_CHOOSER (fontchooser), NULL);
183

184
  return GTK_FONT_CHOOSER_GET_IFACE (fontchooser)->get_font_face (fontchooser);
185 186 187
}

/**
188
 * gtk_font_chooser_get_font_size:
189
 * @fontchooser: a #GtkFontChooser
190 191 192
 *
 * The selected font size.
 *
193
 * Returns: A n integer representing the selected font size,
194 195
 *     or -1 if no font size is selected.
 *
196
 * Since: 3.2
Matthias Clasen's avatar
Matthias Clasen committed
197
 */
198
gint
199
gtk_font_chooser_get_font_size (GtkFontChooser *fontchooser)
200
{
201
  g_return_val_if_fail (GTK_IS_FONT_CHOOSER (fontchooser), -1);
202

203
  return GTK_FONT_CHOOSER_GET_IFACE (fontchooser)->get_font_size (fontchooser);
204 205 206
}

/**
207
 * gtk_font_chooser_get_font:
208
 * @fontchooser: a #GtkFontChooser
209
 *
210 211 212
 * Gets the currently-selected font name.
 *
 * Note that this can be a different string than what you set with
213
 * gtk_font_chooser_set_font(), as the font chooser widget may
214
 * normalize font names and thus return a string with a different
215 216
 * structure. For example, “Helvetica Italic Bold 12” could be
 * normalized to “Helvetica Bold Italic 12”.
217 218 219 220
 *
 * Use pango_font_description_equal() if you want to compare two
 * font descriptions.
 *
221
 * Returns: (transfer full) (allow-none): A string with the name
222 223
 *     of the current font, or %NULL if  no font is selected. You must
 *     free this string with g_free().
224 225
 *
 * Since: 3.2
226 227
 */
gchar *
228
gtk_font_chooser_get_font (GtkFontChooser *fontchooser)
229
{
230 231
  gchar *fontname;

232
  g_return_val_if_fail (GTK_IS_FONT_CHOOSER (fontchooser), NULL);
233

234 235 236 237
  g_object_get (fontchooser, "font", &fontname, NULL);


  return fontname;
238 239 240
}

/**
241
 * gtk_font_chooser_set_font:
242
 * @fontchooser: a #GtkFontChooser
243
 * @fontname: a font name like “Helvetica 12” or “Times Bold 18”
244
 *
245 246
 * Sets the currently-selected font.
 *
247
 * Since: 3.2
248
 */
249
void
250 251
gtk_font_chooser_set_font (GtkFontChooser *fontchooser,
                           const gchar    *fontname)
252
{
253 254
  g_return_if_fail (GTK_IS_FONT_CHOOSER (fontchooser));
  g_return_if_fail (fontname != NULL);
255

256
  g_object_set (fontchooser, "font", fontname, NULL);
257 258
}

259 260 261 262 263 264 265 266 267
/**
 * gtk_font_chooser_get_font_desc:
 * @fontchooser: a #GtkFontChooser
 *
 * Gets the currently-selected font.
 *
 * Note that this can be a different string than what you set with
 * gtk_font_chooser_set_font(), as the font chooser widget may
 * normalize font names and thus return a string with a different
268 269
 * structure. For example, “Helvetica Italic Bold 12” could be
 * normalized to “Helvetica Bold Italic 12”.
270 271 272 273
 *
 * Use pango_font_description_equal() if you want to compare two
 * font descriptions.
 *
274
 * Returns: (transfer full) (allow-none): A #PangoFontDescription for the
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
 *     current font, or %NULL if  no font is selected.
 *
 * Since: 3.2
 */
PangoFontDescription *
gtk_font_chooser_get_font_desc (GtkFontChooser *fontchooser)
{
  PangoFontDescription *font_desc;

  g_return_val_if_fail (GTK_IS_FONT_CHOOSER (fontchooser), NULL);

  g_object_get (fontchooser, "font-desc", &font_desc, NULL);

  return font_desc;
}

/**
 * gtk_font_chooser_set_font_desc:
 * @fontchooser: a #GtkFontChooser
 * @font_desc: a #PangoFontDescription
 *
 * Sets the currently-selected font from @font_desc.
 *
 * Since: 3.2
 */
void
gtk_font_chooser_set_font_desc (GtkFontChooser             *fontchooser,
                                const PangoFontDescription *font_desc)
{
  g_return_if_fail (GTK_IS_FONT_CHOOSER (fontchooser));
  g_return_if_fail (font_desc != NULL);

  g_object_set (fontchooser, "font-desc", font_desc, NULL);
}

310
/**
311 312
 * gtk_font_chooser_get_preview_text:
 * @fontchooser: a #GtkFontChooser
313 314
 *
 * Gets the text displayed in the preview area.
315
 *
316
 * Returns: (transfer full): the text displayed in the
317
 *     preview area
318 319
 *
 * Since: 3.2
320
 */
321
gchar *
322
gtk_font_chooser_get_preview_text (GtkFontChooser *fontchooser)
323
{
324 325
  char *text;

326
  g_return_val_if_fail (GTK_IS_FONT_CHOOSER (fontchooser), NULL);
327

328
  g_object_get (fontchooser, "preview-text", &text, NULL);
329

330 331
  return text;
}
332 333

/**
334 335
 * gtk_font_chooser_set_preview_text:
 * @fontchooser: a #GtkFontChooser
336
 * @text: (transfer none): the text to display in the preview area
337 338 339
 *
 * Sets the text displayed in the preview area.
 * The @text is used to show how the selected font looks.
340 341
 *
 * Since: 3.2
342 343
 */
void
344 345
gtk_font_chooser_set_preview_text (GtkFontChooser *fontchooser,
                                   const gchar    *text)
346
{
347
  g_return_if_fail (GTK_IS_FONT_CHOOSER (fontchooser));
348 349
  g_return_if_fail (text != NULL);

350
  g_object_set (fontchooser, "preview-text", text, NULL);
351 352
}

353
/**
354 355
 * gtk_font_chooser_get_show_preview_entry:
 * @fontchooser: a #GtkFontChooser
356
 *
357 358
 * Returns whether the preview entry is shown or not.
 *
359
 * Returns: %TRUE if the preview entry is shown
360 361
 *     or %FALSE if it is hidden.
 *
362 363 364
 * Since: 3.2
 */
gboolean
365
gtk_font_chooser_get_show_preview_entry (GtkFontChooser *fontchooser)
366
{
367 368
  gboolean show;

369
  g_return_val_if_fail (GTK_IS_FONT_CHOOSER (fontchooser), FALSE);
370

371 372 373
  g_object_get (fontchooser, "show-preview-entry", &show, NULL);

  return show;
374 375 376
}

/**
377 378
 * gtk_font_chooser_set_show_preview_entry:
 * @fontchooser: a #GtkFontChooser
379 380 381
 * @show_preview_entry: whether to show the editable preview entry or not
 *
 * Shows or hides the editable preview entry.
382
 *
383 384 385
 * Since: 3.2
 */
void
386
gtk_font_chooser_set_show_preview_entry (GtkFontChooser *fontchooser,
387
                                         gboolean        show_preview_entry)
388
{
389
  g_return_if_fail (GTK_IS_FONT_CHOOSER (fontchooser));
390

391 392
  show_preview_entry = show_preview_entry != FALSE;
  g_object_set (fontchooser, "show-preview-entry", show_preview_entry, NULL);
393
}
394 395 396 397 398

/**
 * gtk_font_chooser_set_filter_func:
 * @fontchooser: a #GtkFontChooser
 * @filter: (allow-none): a #GtkFontFilterFunc, or %NULL
399
 * @user_data: data to pass to @filter
400 401 402 403 404 405 406 407 408 409
 * @destroy: function to call to free @data when it is no longer needed
 *
 * Adds a filter function that decides which fonts to display
 * in the font chooser.
 *
 * Since: 3.2
 */
void
gtk_font_chooser_set_filter_func (GtkFontChooser   *fontchooser,
                                  GtkFontFilterFunc filter,
410
                                  gpointer          user_data,
411 412 413 414
                                  GDestroyNotify    destroy)
{
  g_return_if_fail (GTK_IS_FONT_CHOOSER (fontchooser));

415 416 417 418 419
  GTK_FONT_CHOOSER_GET_IFACE (fontchooser)->set_filter_func (fontchooser,
                                                             filter,
                                                             user_data,
                                                             destroy);
}
420

421 422 423 424 425
void
_gtk_font_chooser_font_activated (GtkFontChooser *chooser,
                                  const gchar    *fontname)
{
  g_return_if_fail (GTK_IS_FONT_CHOOSER (chooser));
426

427
  g_signal_emit (chooser, chooser_signals[SIGNAL_FONT_ACTIVATED], 0, fontname);
428
}
429 430 431 432 433 434 435 436 437 438

/**
 * gtk_font_chooser_set_font_map:
 * @fontchooser: a #GtkFontChooser
 * @fontmap: (allow-none): a #PangoFontMap
 *
 * Sets a custom font map to use for this font chooser widget.
 * A custom font map can be used to present application-specific
 * fonts instead of or in addition to the normal system fonts.
 *
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
 * |[<!-- language="C" -->
 * FcConfig *config;
 * PangoFontMap *fontmap;
 *
 * config = FcInitLoadConfigAndFonts ();
 * FcConfigAppFontAddFile (config, my_app_font_file);
 *
 * fontmap = pango_cairo_font_map_new_for_font_type (CAIRO_FONT_TYPE_FT);
 * pango_fc_font_map_set_config (PANGO_FC_FONT_MAP (fontmap), config);
 *
 * gtk_font_chooser_set_font_map (font_chooser, fontmap);
 * ]|
 *
 * Note that other GTK+ widgets will only be able to use the application-specific
 * font if it is present in the font map they use:
 *
 * |[
 * context = gtk_widget_get_pango_context (label);
 * pango_context_set_font_map (context, fontmap);
 * ]|
 *
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
 * Since: 3.18
 */
void
gtk_font_chooser_set_font_map (GtkFontChooser *fontchooser,
                               PangoFontMap   *fontmap)
{
  g_return_if_fail (GTK_IS_FONT_CHOOSER (fontchooser));
  g_return_if_fail (fontmap == NULL || PANGO_IS_FONT_MAP (fontmap));

  g_object_set (fontchooser, "font-map", fontmap, NULL);
}

/**
 * gtk_font_chooser_get_font_map:
 * @fontchooser: a #GtkFontChooser
 *
 * Gets the custom font map of this font chooser widget,
 * or %NULL if it does not have one.
 *
 * Returns: (transfer full) (allow-none): a #PangoFontMap, or %NULL
 *
 * Since: 3.18
 */
PangoFontMap *
gtk_font_chooser_get_font_map (GtkFontChooser *fontchooser)
{
  PangoFontMap *fontmap;

  g_return_if_fail (GTK_IS_FONT_CHOOSER (fontchooser));

  g_object_get (fontchooser, "font-map", &fontmap, NULL);

  return fontmap;
}