FontButton

The #GtkFontButton is a button which displays the currently selected font an allows to open a font chooser dialog to change the font. It is suitable widget for selecting a font in a preference dialog.

CSS nodes

GtkFontButton has a single CSS node with name button and style class .font.

Constructors

this
this(GtkFontButton* gtkFontButton, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Creates a new font picker widget.

this
this(string fontname)

Creates a new font picker widget.

Members

Functions

addOnFontSet
gulong addOnFontSet(void delegate(FontButton) dlg, ConnectFlags connectFlags)

The ::font-set signal is emitted when the user selects a font. When handling this signal, use gtk_font_chooser_get_font() to find out which font was just selected.

getFontButtonStruct
GtkFontButton* getFontButtonStruct(bool transferOwnership)

Get the main Gtk struct

getFontName
string getFontName()

Retrieves the name of the currently selected font. This name includes style and size information as well. If you want to render something with the font, use this string with pango_font_description_from_string() . If you’re interested in peeking certain values (family name, style, size, weight) just query these properties from the #PangoFontDescription object.

getShowSize
bool getShowSize()

Returns whether the font size will be shown in the label.

getShowStyle
bool getShowStyle()

Returns whether the name of the font style will be shown in the label.

getStruct
void* getStruct()

the main Gtk struct as a void*

getTitle
string getTitle()

Retrieves the title of the font chooser dialog.

getUseFont
bool getUseFont()

Returns whether the selected font is used in the label.

getUseSize
bool getUseSize()

Returns whether the selected size is used in the label.

setFontName
bool setFontName(string fontname)

Sets or updates the currently-displayed font in font picker dialog.

setShowSize
void setShowSize(bool showSize)

If @show_size is %TRUE, the font size will be displayed along with the name of the selected font.

setShowStyle
void setShowStyle(bool showStyle)

If @show_style is %TRUE, the font style will be displayed along with name of the selected font.

setTitle
void setTitle(string title)

Sets the title for the font chooser dialog.

setUseFont
void setUseFont(bool useFont)

If @use_font is %TRUE, the font name will be written using the selected font.

setUseSize
void setUseSize(bool useSize)

If @use_size is %TRUE, the font name will be written using the selected size.

Mixins

__anonymous
mixin FontChooserT!(GtkFontButton)
Undocumented in source.

Static functions

getType
GType getType()

Variables

gtkFontButton
GtkFontButton* gtkFontButton;

the main Gtk struct

Inherited Members

From Button

gtkButton
GtkButton* gtkButton;

the main Gtk struct

getButtonStruct
GtkButton* getButtonStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

__anonymous
mixin ActionableT!(GtkButton)
Undocumented in source.
__anonymous
mixin ActivatableT!(GtkButton)
Undocumented in source.
setIconSize
void setIconSize(IconSize iconSize)
getIconSize
IconSize getIconSize()
getType
GType getType()
clicked
void clicked()

Emits a #GtkButton::clicked signal to the given #GtkButton.

enter
void enter()

Emits a #GtkButton::enter signal to the given #GtkButton.

getAlignment
void getAlignment(float xalign, float yalign)

Gets the alignment of the child in the button.

getAlwaysShowImage
bool getAlwaysShowImage()

Returns whether the button will ignore the #GtkSettings:gtk-button-images setting and always show the image, if available.

getEventWindow
Window getEventWindow()

Returns the button’s event window if it is realized, %NULL otherwise. This function should be rarely needed.

getFocusOnClick
bool getFocusOnClick()

Returns whether the button grabs focus when it is clicked with the mouse. See gtk_button_set_focus_on_click().

getImage
Widget getImage()

Gets the widget that is currenty set as the image of @button. This may have been explicitly set by gtk_button_set_image() or constructed by gtk_button_new_from_stock().

getImagePosition
GtkPositionType getImagePosition()

Gets the position of the image relative to the text inside the button.

getLabel
string getLabel()

Fetches the text from the label of the button, as set by gtk_button_set_label(). If the label text has not been set the return value will be %NULL. This will be the case if you create an empty button with gtk_button_new() to use as a container.

getRelief
GtkReliefStyle getRelief()

Returns the current relief style of the given #GtkButton.

getUseStock
bool getUseStock()

Returns whether the button label is a stock item.

getUseUnderline
bool getUseUnderline()

Returns whether an embedded underline in the button label indicates a mnemonic. See gtk_button_set_use_underline ().

leave
void leave()

Emits a #GtkButton::leave signal to the given #GtkButton.

pressed
void pressed()

Emits a #GtkButton::pressed signal to the given #GtkButton.

released
void released()

Emits a #GtkButton::released signal to the given #GtkButton.

setAlignment
void setAlignment(float xalign, float yalign)

Sets the alignment of the child. This property has no effect unless the child is a #GtkMisc or a #GtkAlignment.

setAlwaysShowImage
void setAlwaysShowImage(bool alwaysShow)

If %TRUE, the button will ignore the #GtkSettings:gtk-button-images setting and always show the image, if available.

setFocusOnClick
void setFocusOnClick(bool focusOnClick)

Sets whether the button will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.

setImage
void setImage(Widget image)

Set the image of @button to the given widget. The image will be displayed if the label text is %NULL or if #GtkButton:always-show-image is %TRUE. You don’t have to call gtk_widget_show() on @image yourself.

setImagePosition
void setImagePosition(GtkPositionType position)

Sets the position of the image relative to the text inside the button.

setLabel
void setLabel(string label)

Sets the text of the label of the button to @str. This text is also used to select the stock item if gtk_button_set_use_stock() is used.

setRelief
void setRelief(GtkReliefStyle relief)

Sets the relief style of the edges of the given #GtkButton widget. Two styles exist, %GTK_RELIEF_NORMAL and %GTK_RELIEF_NONE. The default style is, as one can guess, %GTK_RELIEF_NORMAL. The deprecated value %GTK_RELIEF_HALF behaves the same as %GTK_RELIEF_NORMAL.

setUseStock
void setUseStock(bool useStock)

If %TRUE, the label set on the button is used as a stock id to select the stock item for the button.

setUseUnderline
void setUseUnderline(bool useUnderline)

If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key.

addOnActivate
gulong addOnActivate(void delegate(Button) dlg, ConnectFlags connectFlags)

The ::activate signal on GtkButton is an action signal and emitting it causes the button to animate press then release. Applications should never connect to this signal, but use the #GtkButton::clicked signal.

addOnClicked
gulong addOnClicked(void delegate(Button) dlg, ConnectFlags connectFlags)

Emitted when the button has been activated (pressed and released).

addOnEnter
gulong addOnEnter(void delegate(Button) dlg, ConnectFlags connectFlags)

Emitted when the pointer enters the button.

addOnLeave
gulong addOnLeave(void delegate(Button) dlg, ConnectFlags connectFlags)

Emitted when the pointer leaves the button.

addOnPressed
gulong addOnPressed(void delegate(Button) dlg, ConnectFlags connectFlags)

Emitted when the button is pressed.

addOnReleased
gulong addOnReleased(void delegate(Button) dlg, ConnectFlags connectFlags)

Emitted when the button is released.

From FontChooserIF

getFontChooserStruct
GtkFontChooser* getFontChooserStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
getFont
string getFont()

Gets the currently-selected font name.

getFontDesc
PgFontDescription getFontDesc()

Gets the currently-selected font.

getFontFace
PgFontFace getFontFace()

Gets the #PangoFontFace representing the selected font group details (i.e. family, slant, weight, width, etc).

getFontFamily
PgFontFamily getFontFamily()

Gets the #PangoFontFamily representing the selected font family. Font families are a collection of font faces.

getFontFeatures
string getFontFeatures()

Gets the currently-selected font features.

getFontMap
PgFontMap getFontMap()

Gets the custom font map of this font chooser widget, or %NULL if it does not have one.

getFontSize
int getFontSize()

The selected font size.

getLanguage
string getLanguage()

Gets the language that is used for font features.

getLevel
GtkFontChooserLevel getLevel()

Returns the current level of granularity for selecting fonts.

getPreviewText
string getPreviewText()

Gets the text displayed in the preview area.

getShowPreviewEntry
bool getShowPreviewEntry()

Returns whether the preview entry is shown or not.

setFilterFunc
void setFilterFunc(GtkFontFilterFunc filter, void* userData, GDestroyNotify destroy)

Adds a filter function that decides which fonts to display in the font chooser.

setFont
void setFont(string fontname)

Sets the currently-selected font.

setFontDesc
void setFontDesc(PgFontDescription fontDesc)

Sets the currently-selected font from @font_desc.

setFontMap
void setFontMap(PgFontMap fontmap)

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.

setLanguage
void setLanguage(string language)

Sets the language to use for font features.

setLevel
void setLevel(GtkFontChooserLevel level)

Sets the desired level of granularity for selecting fonts.

setPreviewText
void setPreviewText(string text)

Sets the text displayed in the preview area. The @text is used to show how the selected font looks.

setShowPreviewEntry
void setShowPreviewEntry(bool showPreviewEntry)

Shows or hides the editable preview entry.

addOnFontActivated
gulong addOnFontActivated(void delegate(string, FontChooserIF) dlg, ConnectFlags connectFlags)

Emitted when a font is activated. 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.

Meta