src/gtk/FontSelection.d

   1 /*
   2  * This file is part of duit.
   3  *
   4  * duit is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser General Public License as published by
   6  * the Free Software Foundation; either version 2.1 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * duit is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with duit; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 // generated automatically - do not change
  20 // find conversion definition on APILookup.txt
  21 // implement new conversion functionalities on the wrap.utils pakage
  22
  23 /*
  24  * Conversion parameters:
  25  * inFile  = GtkFontSelection.html
  26  * outPack = gtk
  27  * outFile = FontSelection
  28  * strct   = GtkFontSelection
  29  * realStrct=
  30  * ctorStrct=
  31  * clss    = FontSelection
  32  * interf  =
  33  * class Code: No
  34  * interface Code: No
  35  * template for:
  36  * extend  =
  37  * implements:
  38  * prefixes:
  39  *      - gtk_font_selection_
  40  *      - gtk_
  41  * omit structs:
  42  * omit prefixes:
  43  * omit code:
  44  * imports:
  45  *      - glib.Str
  46  *      - gdk.Font
  47  * structWrap:
  48  *      - GdkFont* -> Font
  49  * local aliases:
  50  */
  51
  52 module gtk.FontSelection;
  53
  54 private import gtk.gtktypes;
  55
  56 private import lib.gtk;
  57
  58 private import glib.Str;
  59 private import gdk.Font;
  60
  61 /**
  62  * Description
  63  * The GtkFontSelection widget lists the available fonts, styles and sizes,
  64  * allowing the user to select a font.
  65  * It is used in the GtkFontSelectionDialog widget to provide a dialog box for
  66  * selecting fonts.
  67  * To set the font which is initially selected, use
  68  * gtk_font_selection_set_font_name().
  69  * To get the selected font use gtk_font_selection_get_font_name().
  70  * To change the text which is shown in the preview area, use
  71  * gtk_font_selection_set_preview_text().
  72  */
  73 private import gtk.VBox;
  74 public class FontSelection : VBox
  75 {
  76
  77         /** the main Gtk struct */
  78         protected GtkFontSelection* gtkFontSelection;
  79
  80
  81         public GtkFontSelection* getFontSelectionStruct()
  82         {
  83                 return gtkFontSelection;
  84         }
  85
  86
  87         /** the main Gtk struct as a void* */
  88         protected void* getStruct()
  89         {
  90                 return cast(void*)gtkFontSelection;
  91         }
  92
  93         /**
  94          * Sets our main struct and passes it to the parent class
  95          */
  96         public this (GtkFontSelection* gtkFontSelection)
  97         {
  98                 super(cast(GtkVBox*)gtkFontSelection);
  99                 this.gtkFontSelection = gtkFontSelection;
 100         }
 101
 102         /**
 103          */
 104
 105
 106         /**
 107          * Creates a new GtkFontSelection.
 108          * Returns:
 109          * a new GtkFontSelection.
 110          */
 111         public this ()
 112         {
 113                 // GtkWidget* gtk_font_selection_new (void);
 114                 this(cast(GtkFontSelection*)gtk_font_selection_new() );
 115         }
 116
 117         /**
 118          * Warning
 119          * gtk_font_selection_get_font is deprecated and should not be used in newly-written code.
 120          * Gets the currently-selected font.
 121          * fontsel:
 122          * a GtkFontSelection.
 123          * Returns:
 124          * the currently-selected font, or NULL if no font is selected.
 125          */
 126         public Font getFont()
 127         {
 128                 // GdkFont* gtk_font_selection_get_font (GtkFontSelection *fontsel);
 129                 return new Font( gtk_font_selection_get_font(gtkFontSelection) );
 130         }
 131
 132         /**
 133          * Gets the currently-selected font name. Note that this can be a different
 134          * string than what you set with gtk_font_selection_set_font_name(), as
 135          * the font selection widget may normalize font names and thus return a string
 136          * with a different structure. For example, "Helvetica Italic Bold 12" could be
 137          * normalized to "Helvetica Bold Italic 12". Use pango_font_description_equal()
 138          * if you want to compare two font descriptions.
 139          * fontsel:
 140          *  a GtkFontSelection
 141          * Returns:
 142          *  A string with the name of the current font, or NULL if no font
 143          * is selected. You must free this string with g_free().
 144          */
 145         public char[] getFontName()
 146         {
 147                 // gchar* gtk_font_selection_get_font_name  (GtkFontSelection *fontsel);
 148                 return Str.toString(gtk_font_selection_get_font_name(gtkFontSelection) );
 149         }
 150
 151         /**
 152          * Sets the currently-selected font. Note that the fontsel needs to know the
 153          * screen in which it will appear for this to work; this can be guaranteed by
 154          * simply making sure that the fontsel is inserted in a toplevel window before
 155          * you call this function.
 156          * fontsel:
 157          *  a GtkFontSelection
 158          * fontname:
 159          *  a font name like "Helvetica 12" or "Times Bold 18"
 160          * Returns:
 161          *  TRUE if the font could be set successfully; FALSE if no such
 162          * font exists or if the fontsel doesn't belong to a particular screen yet.
 163          */
 164         public int setFontName(char[] fontname)
 165         {
 166                 // gboolean gtk_font_selection_set_font_name  (GtkFontSelection *fontsel,  const gchar *fontname);
 167                 return gtk_font_selection_set_font_name(gtkFontSelection, Str.toStringz(fontname));
 168         }
 169
 170         /**
 171          * Gets the text displayed in the preview area.
 172          * fontsel:
 173          * a GtkFontSelection.
 174          * Returns:
 175          * the text displayed in the preview area. This string is
 176          *  owned by the widget and should not be modified or freed.
 177          */
 178         public char[] getPreviewText()
 179         {
 180                 // const gchar* gtk_font_selection_get_preview_text  (GtkFontSelection *fontsel);
 181                 return Str.toString(gtk_font_selection_get_preview_text(gtkFontSelection) );
 182         }
 183
 184         /**
 185          * Sets the text displayed in the preview area.
 186          * fontsel:
 187          * a GtkFontSelection.
 188          * text:
 189          * the text to display in the preview area.
 190          * Property Details
 191          * The "font" property
 192          *  "font" GdkFont : Read
 193          * The GdkFont that is currently selected.
 194          */
 195         public void setPreviewText(char[] text)
 196         {
 197                 // void gtk_font_selection_set_preview_text  (GtkFontSelection *fontsel,  const gchar *text);
 198                 gtk_font_selection_set_preview_text(gtkFontSelection, Str.toStringz(text));
 199         }
 200
 201
 202 }