GI.Gtk.Objects.FileChooserButton

The FileChooserButton is a widget that lets the user select a file. It implements the FileChooser interface. Visually, it is a file name with a button to bring up a FileChooserDialog. The user can then use that dialog to change the file associated with that button. This widget does not support setting the FileChooser:select-multiple property to True.

Create a button to let the user select a file in /etc

C code

{
  GtkWidget *button;

  button = gtk_file_chooser_button_new (_("Select a file"),
                                        GTK_FILE_CHOOSER_ACTION_OPEN);
  gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (button),
                                       "/etc");
}

The FileChooserButton supports the GtkFileChooserActions FileChooserActionOpen and FileChooserActionSelectFolder.

The 'GI.Gtk.Objects.FileChooserButton.FileChooserButton' will ellipsize the label, and will thus
request little horizontal space.  To give the button more space,
you should call 'GI.Gtk.Objects.Widget.widgetGetPreferredSize',
'GI.Gtk.Objects.FileChooserButton.fileChooserButtonSetWidthChars', or pack the button in
such a way that other interface elements give space to the
widget.

Exported types

newtype FileChooserButton

Constructors

FileChooserButton (ManagedPtr FileChooserButton)

Instances

GObject FileChooserButton

Methods

gobjectType :: FileChooserButton -> IO GType

IsImplementorIface FileChooserButton

IsObject FileChooserButton

IsWidget FileChooserButton

IsContainer FileChooserButton

IsBox FileChooserButton

IsOrientable FileChooserButton

IsFileChooser FileChooserButton

IsBuildable FileChooserButton

IsFileChooserButton FileChooserButton

((~) * info (ResolveFileChooserButtonMethod t FileChooserButton), MethodInfo * info FileChooserButton p) => IsLabel t (FileChooserButton -> p)

Methods

fromLabel :: Proxy# Symbol t -> FileChooserButton -> p

((~) * info (ResolveFileChooserButtonMethod t FileChooserButton), MethodInfo * info FileChooserButton p) => IsLabelProxy t (FileChooserButton -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> FileChooserButton -> p

HasAttributeList * FileChooserButton

type AttributeList FileChooserButton

type AttributeList FileChooserButton

type SignalList FileChooserButton

type SignalList FileChooserButton

class GObject o => IsFileChooserButton o

Instances

(GObject a, UnknownAncestorError Constraint FileChooserButton a) => IsFileChooserButton a

IsFileChooserButton FileChooserButton

toFileChooserButton :: IsFileChooserButton o => o -> IO FileChooserButton

noFileChooserButton :: Maybe FileChooserButton

Methods

getFocusOnClick

data FileChooserButtonGetFocusOnClickMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileChooserButton a) => MethodInfo * FileChooserButtonGetFocusOnClickMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserButtonGetFocusOnClickMethodInfo a -> signature -> s

fileChooserButtonGetFocusOnClick

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserButton a)

=> a

button: a FileChooserButton

-> m Bool

Returns: True if the button grabs focus when it is clicked with the mouse.

Deprecated: (Since version 3.20)Use widgetGetFocusOnClick instead

Returns whether the button grabs focus when it is clicked with the mouse. See fileChooserButtonSetFocusOnClick.

Since: 2.10

getTitle

data FileChooserButtonGetTitleMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsFileChooserButton a) => MethodInfo * FileChooserButtonGetTitleMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserButtonGetTitleMethodInfo a -> signature -> s

fileChooserButtonGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserButton a)

=> a

button: the button widget to examine.

-> m Text

Returns: a pointer to the browse dialog’s title.

Retrieves the title of the browse dialog used by button. The returned value should not be modified or freed.

Since: 2.6

getWidthChars

data FileChooserButtonGetWidthCharsMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsFileChooserButton a) => MethodInfo * FileChooserButtonGetWidthCharsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserButtonGetWidthCharsMethodInfo a -> signature -> s

fileChooserButtonGetWidthChars

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserButton a)

=> a

button: the button widget to examine.

-> m Int32

Returns: an integer width (in characters) that the button will use to size itself.

Retrieves the width in characters of the button widget’s entry and/or label.

Since: 2.6

new

fileChooserButtonNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

title: the title of the browse dialog.

-> FileChooserAction

action: the open mode for the widget.

-> m FileChooserButton

Returns: a new button widget.

Creates a new file-selecting button widget.

Since: 2.6

newWithDialog

fileChooserButtonNewWithDialog

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: the widget to use as dialog

-> m FileChooserButton

Returns: a new button widget.

Creates a FileChooserButton widget which uses dialog as its file-picking window.

Note that dialog must be a Dialog (or subclass) which implements the FileChooser interface and must not have DialogFlagsDestroyWithParent set.

Also note that the dialog needs to have its confirmative button added with response ResponseTypeAccept or ResponseTypeOk in order for the button to take over the file selected in the dialog.

Since: 2.6

setFocusOnClick

data FileChooserButtonSetFocusOnClickMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsFileChooserButton a) => MethodInfo * FileChooserButtonSetFocusOnClickMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserButtonSetFocusOnClickMethodInfo a -> signature -> s

fileChooserButtonSetFocusOnClick

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserButton a)

=> a

button: a FileChooserButton

-> Bool

focusOnClick: whether the button grabs focus when clicked with the mouse

-> m ()

Deprecated: (Since version 3.20)Use widgetSetFocusOnClick instead

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.

Since: 2.10

setTitle

data FileChooserButtonSetTitleMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsFileChooserButton a) => MethodInfo * FileChooserButtonSetTitleMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserButtonSetTitleMethodInfo a -> signature -> s

fileChooserButtonSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserButton a)

=> a

button: the button widget to modify.

-> Text

title: the new browse dialog title.

-> m ()

Modifies the title of the browse dialog used by button.

Since: 2.6

setWidthChars

data FileChooserButtonSetWidthCharsMethodInfo

Instances

((~) * signature (Int32 -> m ()), MonadIO m, IsFileChooserButton a) => MethodInfo * FileChooserButtonSetWidthCharsMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserButtonSetWidthCharsMethodInfo a -> signature -> s

fileChooserButtonSetWidthChars

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserButton a)

=> a

button: the button widget to examine.

-> Int32

nChars: the new width, in characters.

-> m ()

Sets the width (in characters) that button will use to nChars.

Since: 2.6

Properties

dialog

data FileChooserButtonDialogPropertyInfo

Instances

AttrInfo FileChooserButtonDialogPropertyInfo

Associated Types

type AttrAllowedOps FileChooserButtonDialogPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserButtonDialogPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserButtonDialogPropertyInfo :: * -> Constraint

type AttrGetType FileChooserButtonDialogPropertyInfo :: *

type AttrLabel FileChooserButtonDialogPropertyInfo :: Symbol

type AttrOrigin FileChooserButtonDialogPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserButtonDialogPropertyInfo o => Proxy * FileChooserButtonDialogPropertyInfo -> o -> IO (AttrGetType FileChooserButtonDialogPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserButtonDialogPropertyInfo o, AttrSetTypeConstraint FileChooserButtonDialogPropertyInfo b) => Proxy * FileChooserButtonDialogPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserButtonDialogPropertyInfo o => Proxy * FileChooserButtonDialogPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserButtonDialogPropertyInfo o, AttrSetTypeConstraint FileChooserButtonDialogPropertyInfo b) => Proxy * FileChooserButtonDialogPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserButtonDialogPropertyInfo

type AttrOrigin FileChooserButtonDialogPropertyInfo = FileChooserButton

type AttrLabel FileChooserButtonDialogPropertyInfo

type AttrLabel FileChooserButtonDialogPropertyInfo = "dialog"

type AttrGetType FileChooserButtonDialogPropertyInfo

type AttrGetType FileChooserButtonDialogPropertyInfo = ()

type AttrBaseTypeConstraint FileChooserButtonDialogPropertyInfo

type AttrBaseTypeConstraint FileChooserButtonDialogPropertyInfo = IsFileChooserButton

type AttrSetTypeConstraint FileChooserButtonDialogPropertyInfo

type AttrSetTypeConstraint FileChooserButtonDialogPropertyInfo = IsFileChooser

type AttrAllowedOps FileChooserButtonDialogPropertyInfo

type AttrAllowedOps FileChooserButtonDialogPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrClear ([] AttrOpTag))

constructFileChooserButtonDialog :: (IsFileChooserButton o, IsFileChooser a) => a -> IO (GValueConstruct o)

fileChooserButtonDialog :: AttrLabelProxy "dialog"

title

data FileChooserButtonTitlePropertyInfo

Instances

AttrInfo FileChooserButtonTitlePropertyInfo

Associated Types

type AttrAllowedOps FileChooserButtonTitlePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserButtonTitlePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserButtonTitlePropertyInfo :: * -> Constraint

type AttrGetType FileChooserButtonTitlePropertyInfo :: *

type AttrLabel FileChooserButtonTitlePropertyInfo :: Symbol

type AttrOrigin FileChooserButtonTitlePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserButtonTitlePropertyInfo o => Proxy * FileChooserButtonTitlePropertyInfo -> o -> IO (AttrGetType FileChooserButtonTitlePropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserButtonTitlePropertyInfo o, AttrSetTypeConstraint FileChooserButtonTitlePropertyInfo b) => Proxy * FileChooserButtonTitlePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserButtonTitlePropertyInfo o => Proxy * FileChooserButtonTitlePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserButtonTitlePropertyInfo o, AttrSetTypeConstraint FileChooserButtonTitlePropertyInfo b) => Proxy * FileChooserButtonTitlePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserButtonTitlePropertyInfo

type AttrOrigin FileChooserButtonTitlePropertyInfo = FileChooserButton

type AttrLabel FileChooserButtonTitlePropertyInfo

type AttrLabel FileChooserButtonTitlePropertyInfo = "title"

type AttrGetType FileChooserButtonTitlePropertyInfo

type AttrGetType FileChooserButtonTitlePropertyInfo = Text

type AttrBaseTypeConstraint FileChooserButtonTitlePropertyInfo

type AttrBaseTypeConstraint FileChooserButtonTitlePropertyInfo = IsFileChooserButton

type AttrSetTypeConstraint FileChooserButtonTitlePropertyInfo

type AttrSetTypeConstraint FileChooserButtonTitlePropertyInfo = * ~ Text

type AttrAllowedOps FileChooserButtonTitlePropertyInfo

type AttrAllowedOps FileChooserButtonTitlePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserButtonTitle :: IsFileChooserButton o => Text -> IO (GValueConstruct o)

fileChooserButtonTitle :: AttrLabelProxy "title"

getFileChooserButtonTitle :: (MonadIO m, IsFileChooserButton o) => o -> m Text

setFileChooserButtonTitle :: (MonadIO m, IsFileChooserButton o) => o -> Text -> m ()

widthChars

data FileChooserButtonWidthCharsPropertyInfo

Instances

AttrInfo FileChooserButtonWidthCharsPropertyInfo

Associated Types

type AttrAllowedOps FileChooserButtonWidthCharsPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserButtonWidthCharsPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserButtonWidthCharsPropertyInfo :: * -> Constraint

type AttrGetType FileChooserButtonWidthCharsPropertyInfo :: *

type AttrLabel FileChooserButtonWidthCharsPropertyInfo :: Symbol

type AttrOrigin FileChooserButtonWidthCharsPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserButtonWidthCharsPropertyInfo o => Proxy * FileChooserButtonWidthCharsPropertyInfo -> o -> IO (AttrGetType FileChooserButtonWidthCharsPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserButtonWidthCharsPropertyInfo o, AttrSetTypeConstraint FileChooserButtonWidthCharsPropertyInfo b) => Proxy * FileChooserButtonWidthCharsPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserButtonWidthCharsPropertyInfo o => Proxy * FileChooserButtonWidthCharsPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserButtonWidthCharsPropertyInfo o, AttrSetTypeConstraint FileChooserButtonWidthCharsPropertyInfo b) => Proxy * FileChooserButtonWidthCharsPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserButtonWidthCharsPropertyInfo

type AttrOrigin FileChooserButtonWidthCharsPropertyInfo = FileChooserButton

type AttrLabel FileChooserButtonWidthCharsPropertyInfo

type AttrLabel FileChooserButtonWidthCharsPropertyInfo = "width-chars"

type AttrGetType FileChooserButtonWidthCharsPropertyInfo

type AttrGetType FileChooserButtonWidthCharsPropertyInfo = Int32

type AttrBaseTypeConstraint FileChooserButtonWidthCharsPropertyInfo

type AttrBaseTypeConstraint FileChooserButtonWidthCharsPropertyInfo = IsFileChooserButton

type AttrSetTypeConstraint FileChooserButtonWidthCharsPropertyInfo

type AttrSetTypeConstraint FileChooserButtonWidthCharsPropertyInfo = * ~ Int32

type AttrAllowedOps FileChooserButtonWidthCharsPropertyInfo

type AttrAllowedOps FileChooserButtonWidthCharsPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFileChooserButtonWidthChars :: IsFileChooserButton o => Int32 -> IO (GValueConstruct o)

fileChooserButtonWidthChars :: AttrLabelProxy "widthChars"

getFileChooserButtonWidthChars :: (MonadIO m, IsFileChooserButton o) => o -> m Int32

setFileChooserButtonWidthChars :: (MonadIO m, IsFileChooserButton o) => o -> Int32 -> m ()

Signals

fileSet

type C_FileChooserButtonFileSetCallback = Ptr () -> Ptr () -> IO ()

type FileChooserButtonFileSetCallback = IO ()

data FileChooserButtonFileSetSignalInfo

Instances

SignalInfo FileChooserButtonFileSetSignalInfo

Associated Types

type HaskellCallbackType FileChooserButtonFileSetSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o FileChooserButtonFileSetSignalInfo -> o -> HaskellCallbackType FileChooserButtonFileSetSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType FileChooserButtonFileSetSignalInfo

type HaskellCallbackType FileChooserButtonFileSetSignalInfo = FileChooserButtonFileSetCallback

afterFileChooserButtonFileSet :: (GObject a, MonadIO m) => a -> FileChooserButtonFileSetCallback -> m SignalHandlerId

genClosure_FileChooserButtonFileSet :: FileChooserButtonFileSetCallback -> IO Closure

mk_FileChooserButtonFileSetCallback :: C_FileChooserButtonFileSetCallback -> IO (FunPtr C_FileChooserButtonFileSetCallback)

noFileChooserButtonFileSetCallback :: Maybe FileChooserButtonFileSetCallback

onFileChooserButtonFileSet :: (GObject a, MonadIO m) => a -> FileChooserButtonFileSetCallback -> m SignalHandlerId

wrap_FileChooserButtonFileSetCallback :: FileChooserButtonFileSetCallback -> Ptr () -> Ptr () -> IO ()