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(void* ptr, Flag!"Take" take)
this
this()

Creates a new font picker widget.

Members

Functions

connectFontSet
gulong connectFontSet(T callback, Flag!"After" after)

Connect to FontSet signal.

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.FontDescription.fromString . 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.

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.

self
FontButton self()

Returns this, for use in with statements.

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.

Properties

_gType
GType _gType [@property getter]
fontName
string fontName [@property getter]

Get fontName property.

fontName
string fontName [@property setter]

Set fontName property.

showSize
bool showSize [@property getter]

Get showSize property.

showSize
bool showSize [@property setter]

Set showSize property.

showStyle
bool showStyle [@property getter]

Get showStyle property.

showStyle
bool showStyle [@property setter]

Set showStyle property.

title
string title [@property getter]

Get title property.

title
string title [@property setter]

Set title property.

useFont
bool useFont [@property getter]

Get useFont property.

useFont
bool useFont [@property setter]

Set useFont property.

useSize
bool useSize [@property getter]

Get useSize property.

useSize
bool useSize [@property setter]

Set useSize property.

Static functions

_getGType
GType _getGType()
builder
FontButtonGidBuilder builder()

Get builder for gtk.font_button.FontButton

newWithFont
gtk.font_button.FontButton newWithFont(string fontname)

Creates a new font picker widget.

Mixed In Members

From mixin FontChooserT!()

font
string font [@property getter]

Get font property.

font
string font [@property setter]

Set font property.

fontDesc
pango.font_description.FontDescription fontDesc [@property getter]

Get fontDesc property.

fontDesc
pango.font_description.FontDescription fontDesc [@property setter]

Set fontDesc property.

fontFeatures
string fontFeatures [@property getter]

Get fontFeatures property.

language
string language [@property getter]

Get language property.

language
string language [@property setter]

Set language property.

level
gtk.types.FontChooserLevel level [@property getter]

Get level property.

level
gtk.types.FontChooserLevel level [@property setter]

Set level property.

previewText
string previewText [@property getter]

Get previewText property.

previewText
string previewText [@property setter]

Set previewText property.

showPreviewEntry
bool showPreviewEntry [@property getter]

Get showPreviewEntry property.

showPreviewEntry
bool showPreviewEntry [@property setter]

Set showPreviewEntry property.

getFont
string getFont()

Gets the currently-selected font name.

getFontDesc
pango.font_description.FontDescription getFontDesc()

Gets the currently-selected font.

getFontFace
pango.font_face.FontFace getFontFace()

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

getFontFamily
pango.font_family.FontFamily 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
pango.font_map.FontMap 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
gtk.types.FontChooserLevel 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(gtk.types.FontFilterFunc filter)

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(pango.font_description.FontDescription fontDesc)

Sets the currently-selected font from font_desc.

setFontMap
void setFontMap(pango.font_map.FontMap 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(gtk.types.FontChooserLevel 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.

connectFontActivated
gulong connectFontActivated(T callback, Flag!"After" after)

Connect to FontActivated signal.

Inherited Members

From Button

_getGType
GType _getGType()
_gType
GType _gType [@property getter]
self
Button self()

Returns this, for use in with statements.

builder
ButtonGidBuilder builder()

Get builder for gtk.button.Button

alwaysShowImage
bool alwaysShowImage [@property getter]

Get alwaysShowImage property.

alwaysShowImage
bool alwaysShowImage [@property setter]

Set alwaysShowImage property.

image
gtk.widget.Widget image [@property getter]

Get image property.

image
gtk.widget.Widget image [@property setter]

Set image property.

imagePosition
gtk.types.PositionType imagePosition [@property getter]

Get imagePosition property.

imagePosition
gtk.types.PositionType imagePosition [@property setter]

Set imagePosition property.

label
string label [@property getter]
label
string label [@property setter]
relief
gtk.types.ReliefStyle relief [@property getter]
relief
gtk.types.ReliefStyle relief [@property setter]
useStock
bool useStock [@property getter]
useStock
bool useStock [@property setter]
useUnderline
bool useUnderline [@property getter]
useUnderline
bool useUnderline [@property setter]
xalign
float xalign [@property getter]

Get xalign property.

xalign
float xalign [@property setter]

Set xalign property.

yalign
float yalign [@property getter]

Get yalign property.

yalign
float yalign [@property setter]

Set yalign property.

newFromIconName
gtk.button.Button newFromIconName(string iconName, gtk.types.IconSize size)

Creates a new button containing an icon from the current icon theme.

newFromStock
gtk.button.Button newFromStock(string stockId)

Creates a new #GtkButton containing the image and text from a [stock item]gtkstock. Some stock ids have preprocessor macros like #GTK_STOCK_OK and #GTK_STOCK_APPLY.

newWithLabel
gtk.button.Button newWithLabel(string label)

Creates a #GtkButton widget with a #GtkLabel child containing the given text.

newWithMnemonic
gtk.button.Button newWithMnemonic(string label)

Creates a new #GtkButton containing a label. If characters in label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use “__” (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button.

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
gdk.window.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.Button.setFocusOnClick.

getImage
gtk.widget.Widget getImage()

Gets the widget that is currenty set as the image of button. This may have been explicitly set by gtk.button.Button.setImage or constructed by gtk.button.Button.newFromStock.

getImagePosition
gtk.types.PositionType 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.Button.setLabel. 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.Button.new_ to use as a container.

getRelief
gtk.types.ReliefStyle 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(gtk.widget.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.Widget.show on image yourself.

setImagePosition
void setImagePosition(gtk.types.PositionType 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.Button.setUseStock is used.

setRelief
void setRelief(gtk.types.ReliefStyle relief)

Sets the relief style of the edges of the given #GtkButton widget. Two styles exist, gtk.types.ReliefStyle.Normal and gtk.types.ReliefStyle.None. The default style is, as one can guess, gtk.types.ReliefStyle.Normal. The deprecated value gtk.types.ReliefStyle.Half behaves the same as gtk.types.ReliefStyle.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.

connectActivate
gulong connectActivate(T callback, Flag!"After" after)

Connect to Activate signal.

connectClicked
gulong connectClicked(T callback, Flag!"After" after)

Connect to Clicked signal.

connectEnter
gulong connectEnter(T callback, Flag!"After" after)

Connect to Enter signal.

connectLeave
gulong connectLeave(T callback, Flag!"After" after)

Connect to Leave signal.

connectPressed
gulong connectPressed(T callback, Flag!"After" after)

Connect to Pressed signal.

connectReleased
gulong connectReleased(T callback, Flag!"After" after)

Connect to Released signal.

From FontChooser

_getGType
GType _getGType()
font
string font [@property getter]

Get font property.

font
string font [@property setter]

Set font property.

fontDesc
pango.font_description.FontDescription fontDesc [@property getter]

Get fontDesc property.

fontDesc
pango.font_description.FontDescription fontDesc [@property setter]

Set fontDesc property.

fontFeatures
string fontFeatures [@property getter]

Get fontFeatures property.

language
string language [@property getter]

Get language property.

language
string language [@property setter]

Set language property.

level
gtk.types.FontChooserLevel level [@property getter]

Get level property.

level
gtk.types.FontChooserLevel level [@property setter]

Set level property.

previewText
string previewText [@property getter]

Get previewText property.

previewText
string previewText [@property setter]

Set previewText property.

showPreviewEntry
bool showPreviewEntry [@property getter]

Get showPreviewEntry property.

showPreviewEntry
bool showPreviewEntry [@property setter]

Set showPreviewEntry property.

getFont
string getFont()

Gets the currently-selected font name.

getFontDesc
pango.font_description.FontDescription getFontDesc()

Gets the currently-selected font.

getFontFace
pango.font_face.FontFace getFontFace()

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

getFontFamily
pango.font_family.FontFamily 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
pango.font_map.FontMap 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
gtk.types.FontChooserLevel 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(gtk.types.FontFilterFunc filter)

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(pango.font_description.FontDescription fontDesc)

Sets the currently-selected font from font_desc.

setFontMap
void setFontMap(pango.font_map.FontMap 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(gtk.types.FontChooserLevel 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.

connectFontActivated
gulong connectFontActivated(T callback, Flag!"After" after)

Connect to FontActivated signal.