Graphics.UI.Gtk.Selectors.FontSelection

gtk3-0.14.2: Binding to the Gtk+ 3 graphical user interface library

Maintainer | gtk2hs-users@lists.sourceforge.net
Stability | provisional
Portability | portable (depends on GHC)
Safe Haskell | None
Language | Haskell98

Graphics.UI.Gtk.Selectors.FontSelection

Contents

- Detail
- Class Hierarchy
- Types
- Constructors
- Methods
- Attributes

Description

A widget for selecting fonts

Synopsis

- data FontSelection
- class VBoxClass o => FontSelectionClass o
- castToFontSelection :: GObjectClass obj => obj -> FontSelection
- gTypeFontSelection :: GType
- toFontSelection :: FontSelectionClass o => o -> FontSelection
- fontSelectionNew :: IO FontSelection
- fontSelectionGetFontName :: (FontSelectionClass self, GlibString string) => self -> IO (Maybe string)
- fontSelectionSetFontName :: (FontSelectionClass self, GlibString string) => self -> string -> IO Bool
- fontSelectionGetPreviewText :: (FontSelectionClass self, GlibString string) => self -> IO string
- fontSelectionSetPreviewText :: (FontSelectionClass self, GlibString string) => self -> string -> IO ()
- fontSelectionFontName :: (FontSelectionClass self, GlibString string) => Attr self string
- fontSelectionPreviewText :: (FontSelectionClass self, GlibString string) => Attr self string

# Detail

The `FontSelection` widget lists the available fonts, styles and sizes, allowing the user to select a font. It is used in the `FontSelectionDialog` widget to provide a dialog box for selecting fonts.

To set the font which is initially selected, use `fontSelectionSetFontName`.

To get the selected font use `fontSelectionGetFontName`.

To change the text which is shown in the preview area, use `fontSelectionSetPreviewText`.

# Class Hierarchy

    | GObject
    | +----Object
    | +----Widget
    | +----Container
    | +----Box
    | +----VBox
    | +----FontSelection

# Types

data FontSelection

Instances

Eq FontSelection |
Ord FontSelection |
GObjectClass FontSelection |
FontSelectionClass FontSelection |
VBoxClass FontSelection |
BoxClass FontSelection |
ContainerClass FontSelection |
WidgetClass FontSelection |

class VBoxClass o => FontSelectionClass o

Instances

FontSelectionClass FontSelection |

castToFontSelection :: GObjectClass obj => obj -> FontSelection

gTypeFontSelection :: GType

toFontSelection :: FontSelectionClass o => o -> FontSelection

# Constructors

fontSelectionNew :: IO FontSelection

Creates a new `FontSelection`.

# Methods

fontSelectionGetFontName

Arguments

:: (FontSelectionClass self, GlibString string) |
=> self |
-> IO (Maybe string) | returns the name of the currently selected font, or `Nothing` if no font is selected.

Gets the currently-selected font name.

fontSelectionSetFontName

Arguments

:: (FontSelectionClass self, GlibString string) |
=> self |
-> string | `fontname` - a fontname.
-> IO Bool | returns `True` if the font was found.

Sets the currently-selected font.

fontSelectionGetPreviewText :: (FontSelectionClass self, GlibString string) => self -> IO string

Gets the text displayed in the preview area.

fontSelectionSetPreviewText :: (FontSelectionClass self, GlibString string) => self -> string -> IO ()

Sets the text displayed in the preview area.

# Attributes

fontSelectionFontName :: (FontSelectionClass self, GlibString string) => Attr self string

The X string that represents this font.

Default value: ""

fontSelectionPreviewText :: (FontSelectionClass self, GlibString string) => Attr self string

The text to display in order to demonstrate the selected font.

Default value: "abcdefghijk ABCDEFGHIJK"