gi-clutter-1.0.2: clutter GObject bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Clutter.Objects.StageManager

Description

The StageManager structure is private.

Since: 1.0

Synopsis

Exported types

class (GObject o, IsDescendantOf StageManager o) => IsStageManager o Source #

Type class for types which can be safely cast to StageManager, for instance with toStageManager.

Instances

Instances details
(GObject o, IsDescendantOf StageManager o) => IsStageManager o Source # 
Instance details

Defined in GI.Clutter.Objects.StageManager

toStageManager :: (MonadIO m, IsStageManager o) => o -> m StageManager Source #

Cast to StageManager, for types for which this is known to be safe. For general casts, use castTo.

Methods

getDefault

stageManagerGetDefault Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m StageManager

Returns: the default stage manager instance. The returned object is owned by Clutter and you should not reference or unreference it.

Returns the default StageManager.

Since: 0.8

getDefaultStage

stageManagerGetDefaultStage Source #

Arguments

:: (HasCallStack, MonadIO m, IsStageManager a) 
=> a

stageManager: a StageManager

-> m Stage

Returns: the default stage. The returned object is owned by Clutter and you should never reference or unreference it

Returns the default Stage.

Since: 0.8

listStages

stageManagerListStages Source #

Arguments

:: (HasCallStack, MonadIO m, IsStageManager a) 
=> a

stageManager: a StageManager

-> m [Stage]

Returns: a newly allocated list of Stage objects. Use g_slist_free() to deallocate it when done.

Lists all currently used stages.

Since: 0.8

peekStages

stageManagerPeekStages Source #

Arguments

:: (HasCallStack, MonadIO m, IsStageManager a) 
=> a

stageManager: a StageManager

-> m [Stage]

Returns: a pointer to the internal list of Stage objects. The returned list is owned by the StageManager and should never be modified or freed

Lists all currently used stages.

Since: 1.0

setDefaultStage

stageManagerSetDefaultStage Source #

Arguments

:: (HasCallStack, MonadIO m, IsStageManager a, IsStage b) 
=> a

stageManager: a StageManager

-> b

stage: a Stage

-> m () 

Deprecated: (Since version 1.2)Calling this function has no effect

Sets stage as the default stage.

Since: 0.8

Properties

defaultStage

The default stage used by Clutter.

Since: 0.8

getStageManagerDefaultStage :: (MonadIO m, IsStageManager o) => o -> m Stage Source #

Get the value of the “default-stage” property. When overloading is enabled, this is equivalent to

get stageManager #defaultStage

Signals

stageAdded

type StageManagerStageAddedCallback Source #

Arguments

 = Stage

stage: the added stage

-> IO () 

The stageAdded signal is emitted each time a new Stage has been added to the stage manager.

Since: 0.8

afterStageManagerStageAdded :: (IsStageManager a, MonadIO m) => a -> ((?self :: a) => StageManagerStageAddedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the stageAdded signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after stageManager #stageAdded callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onStageManagerStageAdded :: (IsStageManager a, MonadIO m) => a -> ((?self :: a) => StageManagerStageAddedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the stageAdded signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on stageManager #stageAdded callback

stageRemoved

type StageManagerStageRemovedCallback Source #

Arguments

 = Stage

stage: the removed stage

-> IO () 

The stageRemoved signal is emitted each time a Stage has been removed from the stage manager.

Since: 0.8

afterStageManagerStageRemoved :: (IsStageManager a, MonadIO m) => a -> ((?self :: a) => StageManagerStageRemovedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the stageRemoved signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after stageManager #stageRemoved callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onStageManagerStageRemoved :: (IsStageManager a, MonadIO m) => a -> ((?self :: a) => StageManagerStageRemovedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the stageRemoved signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on stageManager #stageRemoved callback