Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- addActionWidget
- appendPage
- commit
- getCurrentPage
- getNPages
- getNthPage
- getPageComplete
- getPageHasPadding
- getPageHeaderImage
- getPageSideImage
- getPageTitle
- getPageType
- insertPage
- new
- nextPage
- prependPage
- previousPage
- removeActionWidget
- removePage
- setCurrentPage
- setForwardPageFunc
- setPageComplete
- setPageHasPadding
- setPageHeaderImage
- setPageSideImage
- setPageTitle
- setPageType
- updateButtonsState
- Properties
- Signals
A Assistant
is a widget used to represent a generally complex
operation splitted in several steps, guiding the user through its
pages and controlling the page flow to collect the necessary data.
The design of GtkAssistant is that it controls what buttons to show and to make sensitive, based on what it knows about the page sequence and the [type][GtkAssistantPageType] of each page, in addition to state information like the page [completion][gtk-assistant-set-page-complete] and [committed][gtk-assistant-commit] status.
If you have a case that doesn’t quite fit in GtkAssistants
way of
handling buttons, you can use the GTK_ASSISTANT_PAGE_CUSTOM
page
type and handle buttons yourself.
GtkAssistant as GtkBuildable
The GtkAssistant implementation of the Buildable
interface
exposes the actionArea
as internal children with the name
“action_area”.
To add pages to an assistant in Builder
, simply add it as a
child to the GtkAssistant object, and set its child properties
as necessary.
CSS nodes
GtkAssistant has a single CSS node with the name assistant.
- newtype Assistant = Assistant (ManagedPtr Assistant)
- class GObject o => IsAssistant o
- toAssistant :: IsAssistant o => o -> IO Assistant
- noAssistant :: Maybe Assistant
- data AssistantAddActionWidgetMethodInfo
- assistantAddActionWidget :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> m ()
- data AssistantAppendPageMethodInfo
- assistantAppendPage :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> m Int32
- data AssistantCommitMethodInfo
- assistantCommit :: (HasCallStack, MonadIO m, IsAssistant a) => a -> m ()
- data AssistantGetCurrentPageMethodInfo
- assistantGetCurrentPage :: (HasCallStack, MonadIO m, IsAssistant a) => a -> m Int32
- data AssistantGetNPagesMethodInfo
- assistantGetNPages :: (HasCallStack, MonadIO m, IsAssistant a) => a -> m Int32
- data AssistantGetNthPageMethodInfo
- assistantGetNthPage :: (HasCallStack, MonadIO m, IsAssistant a) => a -> Int32 -> m (Maybe Widget)
- data AssistantGetPageCompleteMethodInfo
- assistantGetPageComplete :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> m Bool
- data AssistantGetPageHasPaddingMethodInfo
- assistantGetPageHasPadding :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> m Bool
- data AssistantGetPageHeaderImageMethodInfo
- assistantGetPageHeaderImage :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> m Pixbuf
- data AssistantGetPageSideImageMethodInfo
- assistantGetPageSideImage :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> m Pixbuf
- data AssistantGetPageTitleMethodInfo
- assistantGetPageTitle :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> m Text
- data AssistantGetPageTypeMethodInfo
- assistantGetPageType :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> m AssistantPageType
- data AssistantInsertPageMethodInfo
- assistantInsertPage :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> Int32 -> m Int32
- assistantNew :: (HasCallStack, MonadIO m) => m Assistant
- data AssistantNextPageMethodInfo
- assistantNextPage :: (HasCallStack, MonadIO m, IsAssistant a) => a -> m ()
- data AssistantPrependPageMethodInfo
- assistantPrependPage :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> m Int32
- data AssistantPreviousPageMethodInfo
- assistantPreviousPage :: (HasCallStack, MonadIO m, IsAssistant a) => a -> m ()
- data AssistantRemoveActionWidgetMethodInfo
- assistantRemoveActionWidget :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> m ()
- data AssistantRemovePageMethodInfo
- assistantRemovePage :: (HasCallStack, MonadIO m, IsAssistant a) => a -> Int32 -> m ()
- data AssistantSetCurrentPageMethodInfo
- assistantSetCurrentPage :: (HasCallStack, MonadIO m, IsAssistant a) => a -> Int32 -> m ()
- data AssistantSetForwardPageFuncMethodInfo
- assistantSetForwardPageFunc :: (HasCallStack, MonadIO m, IsAssistant a) => a -> Maybe AssistantPageFunc -> m ()
- data AssistantSetPageCompleteMethodInfo
- assistantSetPageComplete :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> Bool -> m ()
- data AssistantSetPageHasPaddingMethodInfo
- assistantSetPageHasPadding :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> Bool -> m ()
- data AssistantSetPageHeaderImageMethodInfo
- assistantSetPageHeaderImage :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b, IsPixbuf c) => a -> b -> Maybe c -> m ()
- data AssistantSetPageSideImageMethodInfo
- assistantSetPageSideImage :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b, IsPixbuf c) => a -> b -> Maybe c -> m ()
- data AssistantSetPageTitleMethodInfo
- assistantSetPageTitle :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> Text -> m ()
- data AssistantSetPageTypeMethodInfo
- assistantSetPageType :: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) => a -> b -> AssistantPageType -> m ()
- data AssistantUpdateButtonsStateMethodInfo
- assistantUpdateButtonsState :: (HasCallStack, MonadIO m, IsAssistant a) => a -> m ()
- data AssistantUseHeaderBarPropertyInfo
- assistantUseHeaderBar :: AttrLabelProxy "useHeaderBar"
- constructAssistantUseHeaderBar :: IsAssistant o => Int32 -> IO (GValueConstruct o)
- getAssistantUseHeaderBar :: (MonadIO m, IsAssistant o) => o -> m Int32
- type AssistantApplyCallback = IO ()
- data AssistantApplySignalInfo
- type C_AssistantApplyCallback = Ptr () -> Ptr () -> IO ()
- afterAssistantApply :: (GObject a, MonadIO m) => a -> AssistantApplyCallback -> m SignalHandlerId
- genClosure_AssistantApply :: AssistantApplyCallback -> IO Closure
- mk_AssistantApplyCallback :: C_AssistantApplyCallback -> IO (FunPtr C_AssistantApplyCallback)
- noAssistantApplyCallback :: Maybe AssistantApplyCallback
- onAssistantApply :: (GObject a, MonadIO m) => a -> AssistantApplyCallback -> m SignalHandlerId
- wrap_AssistantApplyCallback :: AssistantApplyCallback -> Ptr () -> Ptr () -> IO ()
- type AssistantCancelCallback = IO ()
- data AssistantCancelSignalInfo
- type C_AssistantCancelCallback = Ptr () -> Ptr () -> IO ()
- afterAssistantCancel :: (GObject a, MonadIO m) => a -> AssistantCancelCallback -> m SignalHandlerId
- genClosure_AssistantCancel :: AssistantCancelCallback -> IO Closure
- mk_AssistantCancelCallback :: C_AssistantCancelCallback -> IO (FunPtr C_AssistantCancelCallback)
- noAssistantCancelCallback :: Maybe AssistantCancelCallback
- onAssistantCancel :: (GObject a, MonadIO m) => a -> AssistantCancelCallback -> m SignalHandlerId
- wrap_AssistantCancelCallback :: AssistantCancelCallback -> Ptr () -> Ptr () -> IO ()
- type AssistantCloseCallback = IO ()
- data AssistantCloseSignalInfo
- type C_AssistantCloseCallback = Ptr () -> Ptr () -> IO ()
- afterAssistantClose :: (GObject a, MonadIO m) => a -> AssistantCloseCallback -> m SignalHandlerId
- genClosure_AssistantClose :: AssistantCloseCallback -> IO Closure
- mk_AssistantCloseCallback :: C_AssistantCloseCallback -> IO (FunPtr C_AssistantCloseCallback)
- noAssistantCloseCallback :: Maybe AssistantCloseCallback
- onAssistantClose :: (GObject a, MonadIO m) => a -> AssistantCloseCallback -> m SignalHandlerId
- wrap_AssistantCloseCallback :: AssistantCloseCallback -> Ptr () -> Ptr () -> IO ()
- type AssistantEscapeCallback = IO ()
- data AssistantEscapeSignalInfo
- type C_AssistantEscapeCallback = Ptr () -> Ptr () -> IO ()
- afterAssistantEscape :: (GObject a, MonadIO m) => a -> AssistantEscapeCallback -> m SignalHandlerId
- genClosure_AssistantEscape :: AssistantEscapeCallback -> IO Closure
- mk_AssistantEscapeCallback :: C_AssistantEscapeCallback -> IO (FunPtr C_AssistantEscapeCallback)
- noAssistantEscapeCallback :: Maybe AssistantEscapeCallback
- onAssistantEscape :: (GObject a, MonadIO m) => a -> AssistantEscapeCallback -> m SignalHandlerId
- wrap_AssistantEscapeCallback :: AssistantEscapeCallback -> Ptr () -> Ptr () -> IO ()
- type AssistantPrepareCallback = Widget -> IO ()
- data AssistantPrepareSignalInfo
- type C_AssistantPrepareCallback = Ptr () -> Ptr Widget -> Ptr () -> IO ()
- afterAssistantPrepare :: (GObject a, MonadIO m) => a -> AssistantPrepareCallback -> m SignalHandlerId
- genClosure_AssistantPrepare :: AssistantPrepareCallback -> IO Closure
- mk_AssistantPrepareCallback :: C_AssistantPrepareCallback -> IO (FunPtr C_AssistantPrepareCallback)
- noAssistantPrepareCallback :: Maybe AssistantPrepareCallback
- onAssistantPrepare :: (GObject a, MonadIO m) => a -> AssistantPrepareCallback -> m SignalHandlerId
- wrap_AssistantPrepareCallback :: AssistantPrepareCallback -> Ptr () -> Ptr Widget -> Ptr () -> IO ()
Exported types
GObject Assistant Source # | |
IsImplementorIface Assistant Source # | |
IsObject Assistant Source # | |
IsWindow Assistant Source # | |
IsWidget Assistant Source # | |
IsContainer Assistant Source # | |
IsBin Assistant Source # | |
IsBuildable Assistant Source # | |
IsAssistant Assistant Source # | |
((~) * info (ResolveAssistantMethod t Assistant), MethodInfo * info Assistant p) => IsLabel t (Assistant -> p) Source # | |
((~) * info (ResolveAssistantMethod t Assistant), MethodInfo * info Assistant p) => IsLabelProxy t (Assistant -> p) Source # | |
HasAttributeList * Assistant Source # | |
type AttributeList Assistant Source # | |
type SignalList Assistant Source # | |
class GObject o => IsAssistant o Source #
toAssistant :: IsAssistant o => o -> IO Assistant Source #
Methods
addActionWidget
data AssistantAddActionWidgetMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantAddActionWidgetMethodInfo a signature Source # | |
assistantAddActionWidget Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Adds a widget to the action area of a Assistant
.
Since: 2.10
appendPage
data AssistantAppendPageMethodInfo Source #
((~) * signature (b -> m Int32), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantAppendPageMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> m Int32 | Returns: the index (starting at 0) of the inserted page |
Appends a page to the assistant
.
Since: 2.10
commit
data AssistantCommitMethodInfo Source #
((~) * signature (m ()), MonadIO m, IsAssistant a) => MethodInfo * AssistantCommitMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAssistant a) | |
=> a |
|
-> m () |
Erases the visited page history so the back button is not shown on the current page, and removes the cancel button from subsequent pages.
Use this when the information provided up to the current page is hereafter deemed permanent and cannot be modified or undone. For example, showing a progress page to track a long-running, unreversible operation after the user has clicked apply on a confirmation page.
Since: 2.22
getCurrentPage
data AssistantGetCurrentPageMethodInfo Source #
((~) * signature (m Int32), MonadIO m, IsAssistant a) => MethodInfo * AssistantGetCurrentPageMethodInfo a signature Source # | |
assistantGetCurrentPage Source #
:: (HasCallStack, MonadIO m, IsAssistant a) | |
=> a |
|
-> m Int32 | Returns: The index (starting from 0) of the current
page in the |
Returns the page number of the current page.
Since: 2.10
getNPages
data AssistantGetNPagesMethodInfo Source #
((~) * signature (m Int32), MonadIO m, IsAssistant a) => MethodInfo * AssistantGetNPagesMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAssistant a) | |
=> a |
|
-> m Int32 | Returns: the number of pages in the |
Returns the number of pages in the assistant
Since: 2.10
getNthPage
data AssistantGetNthPageMethodInfo Source #
((~) * signature (Int32 -> m (Maybe Widget)), MonadIO m, IsAssistant a) => MethodInfo * AssistantGetNthPageMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAssistant a) | |
=> a |
|
-> Int32 |
|
-> m (Maybe Widget) | Returns: the child widget, or |
Returns the child widget contained in page number pageNum
.
Since: 2.10
getPageComplete
data AssistantGetPageCompleteMethodInfo Source #
((~) * signature (b -> m Bool), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantGetPageCompleteMethodInfo a signature Source # | |
assistantGetPageComplete Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> m Bool | Returns: |
Gets whether page
is complete.
Since: 2.10
getPageHasPadding
data AssistantGetPageHasPaddingMethodInfo Source #
((~) * signature (b -> m Bool), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantGetPageHasPaddingMethodInfo a signature Source # | |
assistantGetPageHasPadding Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> m Bool | Returns: |
Gets whether page has padding.
Since: 3.18
getPageHeaderImage
data AssistantGetPageHeaderImageMethodInfo Source #
((~) * signature (b -> m Pixbuf), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantGetPageHeaderImageMethodInfo a signature Source # | |
assistantGetPageHeaderImage Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> m Pixbuf | Returns: the header image for |
Deprecated: (Since version 3.2)Since GTK+ 3.2, a header is no longer shown; add your header decoration to the page content instead.
Gets the header image for page
.
Since: 2.10
getPageSideImage
data AssistantGetPageSideImageMethodInfo Source #
((~) * signature (b -> m Pixbuf), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantGetPageSideImageMethodInfo a signature Source # | |
assistantGetPageSideImage Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> m Pixbuf | Returns: the side image for |
Deprecated: (Since version 3.2)Since GTK+ 3.2, sidebar images are not shown anymore.
Gets the side image for page
.
Since: 2.10
getPageTitle
data AssistantGetPageTitleMethodInfo Source #
((~) * signature (b -> m Text), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantGetPageTitleMethodInfo a signature Source # | |
assistantGetPageTitle Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> m Text | Returns: the title for |
Gets the title for page
.
Since: 2.10
getPageType
data AssistantGetPageTypeMethodInfo Source #
((~) * signature (b -> m AssistantPageType), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantGetPageTypeMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> m AssistantPageType | Returns: the page type of |
Gets the page type of page
.
Since: 2.10
insertPage
data AssistantInsertPageMethodInfo Source #
((~) * signature (b -> Int32 -> m Int32), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantInsertPageMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> Int32 |
|
-> m Int32 | Returns: the index (starting from 0) of the inserted page |
Inserts a page in the assistant
at a given position.
Since: 2.10
new
:: (HasCallStack, MonadIO m) | |
=> m Assistant | Returns: a newly created |
Creates a new Assistant
.
Since: 2.10
nextPage
data AssistantNextPageMethodInfo Source #
((~) * signature (m ()), MonadIO m, IsAssistant a) => MethodInfo * AssistantNextPageMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAssistant a) | |
=> a |
|
-> m () |
Navigate to the next page.
It is a programming error to call this function when there is no next page.
This function is for use when creating pages of the
GTK_ASSISTANT_PAGE_CUSTOM
type.
Since: 3.0
prependPage
data AssistantPrependPageMethodInfo Source #
((~) * signature (b -> m Int32), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantPrependPageMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> m Int32 | Returns: the index (starting at 0) of the inserted page |
Prepends a page to the assistant
.
Since: 2.10
previousPage
data AssistantPreviousPageMethodInfo Source #
((~) * signature (m ()), MonadIO m, IsAssistant a) => MethodInfo * AssistantPreviousPageMethodInfo a signature Source # | |
assistantPreviousPage Source #
:: (HasCallStack, MonadIO m, IsAssistant a) | |
=> a |
|
-> m () |
Navigate to the previous visited page.
It is a programming error to call this function when no previous page is available.
This function is for use when creating pages of the
GTK_ASSISTANT_PAGE_CUSTOM
type.
Since: 3.0
removeActionWidget
data AssistantRemoveActionWidgetMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantRemoveActionWidgetMethodInfo a signature Source # | |
assistantRemoveActionWidget Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Removes a widget from the action area of a Assistant
.
Since: 2.10
removePage
data AssistantRemovePageMethodInfo Source #
((~) * signature (Int32 -> m ()), MonadIO m, IsAssistant a) => MethodInfo * AssistantRemovePageMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAssistant a) | |
=> a |
|
-> Int32 |
|
-> m () |
Removes the pageNum
’s page from assistant
.
Since: 3.2
setCurrentPage
data AssistantSetCurrentPageMethodInfo Source #
((~) * signature (Int32 -> m ()), MonadIO m, IsAssistant a) => MethodInfo * AssistantSetCurrentPageMethodInfo a signature Source # | |
assistantSetCurrentPage Source #
:: (HasCallStack, MonadIO m, IsAssistant a) | |
=> a |
|
-> Int32 |
|
-> m () |
Switches the page to pageNum
.
Note that this will only be necessary in custom buttons,
as the assistant
flow can be set with
assistantSetForwardPageFunc
.
Since: 2.10
setForwardPageFunc
data AssistantSetForwardPageFuncMethodInfo Source #
((~) * signature (Maybe AssistantPageFunc -> m ()), MonadIO m, IsAssistant a) => MethodInfo * AssistantSetForwardPageFuncMethodInfo a signature Source # | |
assistantSetForwardPageFunc Source #
:: (HasCallStack, MonadIO m, IsAssistant a) | |
=> a |
|
-> Maybe AssistantPageFunc |
|
-> m () |
Sets the page forwarding function to be pageFunc
.
This function will be used to determine what will be
the next page when the user presses the forward button.
Setting pageFunc
to Nothing
will make the assistant to
use the default forward function, which just goes to the
next visible page.
Since: 2.10
setPageComplete
data AssistantSetPageCompleteMethodInfo Source #
((~) * signature (b -> Bool -> m ()), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantSetPageCompleteMethodInfo a signature Source # | |
assistantSetPageComplete Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> Bool |
|
-> m () |
Sets whether page
contents are complete.
This will make assistant
update the buttons state
to be able to continue the task.
Since: 2.10
setPageHasPadding
data AssistantSetPageHasPaddingMethodInfo Source #
((~) * signature (b -> Bool -> m ()), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantSetPageHasPaddingMethodInfo a signature Source # | |
assistantSetPageHasPadding Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> Bool |
|
-> m () |
Sets whether the assistant is adding padding around the page.
Since: 3.18
setPageHeaderImage
data AssistantSetPageHeaderImageMethodInfo Source #
((~) * signature (b -> Maybe c -> m ()), MonadIO m, IsAssistant a, IsWidget b, IsPixbuf c) => MethodInfo * AssistantSetPageHeaderImageMethodInfo a signature Source # | |
assistantSetPageHeaderImage Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b, IsPixbuf c) | |
=> a |
|
-> b |
|
-> Maybe c |
|
-> m () |
Deprecated: (Since version 3.2)Since GTK+ 3.2, a header is no longer shown; add your header decoration to the page content instead.
Sets a header image for page
.
Since: 2.10
setPageSideImage
data AssistantSetPageSideImageMethodInfo Source #
((~) * signature (b -> Maybe c -> m ()), MonadIO m, IsAssistant a, IsWidget b, IsPixbuf c) => MethodInfo * AssistantSetPageSideImageMethodInfo a signature Source # | |
assistantSetPageSideImage Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b, IsPixbuf c) | |
=> a |
|
-> b |
|
-> Maybe c |
|
-> m () |
Deprecated: (Since version 3.2)Since GTK+ 3.2, sidebar images are not shown anymore.
Sets a side image for page
.
This image used to be displayed in the side area of the assistant
when page
is the current page.
Since: 2.10
setPageTitle
data AssistantSetPageTitleMethodInfo Source #
((~) * signature (b -> Text -> m ()), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantSetPageTitleMethodInfo a signature Source # | |
assistantSetPageTitle Source #
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> Text |
|
-> m () |
Sets a title for page
.
The title is displayed in the header area of the assistant
when page
is the current page.
Since: 2.10
setPageType
data AssistantSetPageTypeMethodInfo Source #
((~) * signature (b -> AssistantPageType -> m ()), MonadIO m, IsAssistant a, IsWidget b) => MethodInfo * AssistantSetPageTypeMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsAssistant a, IsWidget b) | |
=> a |
|
-> b |
|
-> AssistantPageType |
|
-> m () |
Sets the page type for page
.
The page type determines the page behavior in the assistant
.
Since: 2.10
updateButtonsState
data AssistantUpdateButtonsStateMethodInfo Source #
((~) * signature (m ()), MonadIO m, IsAssistant a) => MethodInfo * AssistantUpdateButtonsStateMethodInfo a signature Source # | |
assistantUpdateButtonsState Source #
:: (HasCallStack, MonadIO m, IsAssistant a) | |
=> a |
|
-> m () |
Forces assistant
to recompute the buttons state.
GTK+ automatically takes care of this in most situations, e.g. when the user goes to a different page, or when the visibility or completeness of a page changes.
One situation where it can be necessary to call this function is when changing a value on the current page affects the future page flow of the assistant.
Since: 2.10
Properties
useHeaderBar
data AssistantUseHeaderBarPropertyInfo Source #
assistantUseHeaderBar :: AttrLabelProxy "useHeaderBar" Source #
constructAssistantUseHeaderBar :: IsAssistant o => Int32 -> IO (GValueConstruct o) Source #
getAssistantUseHeaderBar :: (MonadIO m, IsAssistant o) => o -> m Int32 Source #
Signals
apply
type AssistantApplyCallback = IO () Source #
afterAssistantApply :: (GObject a, MonadIO m) => a -> AssistantApplyCallback -> m SignalHandlerId Source #
mk_AssistantApplyCallback :: C_AssistantApplyCallback -> IO (FunPtr C_AssistantApplyCallback) Source #
onAssistantApply :: (GObject a, MonadIO m) => a -> AssistantApplyCallback -> m SignalHandlerId Source #
wrap_AssistantApplyCallback :: AssistantApplyCallback -> Ptr () -> Ptr () -> IO () Source #
cancel
type AssistantCancelCallback = IO () Source #
afterAssistantCancel :: (GObject a, MonadIO m) => a -> AssistantCancelCallback -> m SignalHandlerId Source #
mk_AssistantCancelCallback :: C_AssistantCancelCallback -> IO (FunPtr C_AssistantCancelCallback) Source #
onAssistantCancel :: (GObject a, MonadIO m) => a -> AssistantCancelCallback -> m SignalHandlerId Source #
wrap_AssistantCancelCallback :: AssistantCancelCallback -> Ptr () -> Ptr () -> IO () Source #
close
type AssistantCloseCallback = IO () Source #
afterAssistantClose :: (GObject a, MonadIO m) => a -> AssistantCloseCallback -> m SignalHandlerId Source #
mk_AssistantCloseCallback :: C_AssistantCloseCallback -> IO (FunPtr C_AssistantCloseCallback) Source #
onAssistantClose :: (GObject a, MonadIO m) => a -> AssistantCloseCallback -> m SignalHandlerId Source #
wrap_AssistantCloseCallback :: AssistantCloseCallback -> Ptr () -> Ptr () -> IO () Source #
escape
type AssistantEscapeCallback = IO () Source #
afterAssistantEscape :: (GObject a, MonadIO m) => a -> AssistantEscapeCallback -> m SignalHandlerId Source #
mk_AssistantEscapeCallback :: C_AssistantEscapeCallback -> IO (FunPtr C_AssistantEscapeCallback) Source #
onAssistantEscape :: (GObject a, MonadIO m) => a -> AssistantEscapeCallback -> m SignalHandlerId Source #
wrap_AssistantEscapeCallback :: AssistantEscapeCallback -> Ptr () -> Ptr () -> IO () Source #
prepare
type AssistantPrepareCallback = Widget -> IO () Source #
afterAssistantPrepare :: (GObject a, MonadIO m) => a -> AssistantPrepareCallback -> m SignalHandlerId Source #
mk_AssistantPrepareCallback :: C_AssistantPrepareCallback -> IO (FunPtr C_AssistantPrepareCallback) Source #
onAssistantPrepare :: (GObject a, MonadIO m) => a -> AssistantPrepareCallback -> m SignalHandlerId Source #
wrap_AssistantPrepareCallback :: AssistantPrepareCallback -> Ptr () -> Ptr Widget -> Ptr () -> IO () Source #