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

GI.Atk.Interfaces.Component

Contents

Exported types
Methods
Signals
- boundsChanged

Description

Component should be implemented by most if not all UI elements with an actual on-screen presence, i.e. components which can be said to have a screen-coordinate bounding box. Virtually all widgets will need to have Component implementations provided for their corresponding Object class. In short, only UI elements which are *not* GUI elements will omit this ATK interface.

A possible exception might be textual information with a transparent background, in which case text glyph bounding box information is provided by Text.

Synopsis

Exported types

newtype Component #

Constructors

Component (ManagedPtr Component)

Instances

GObject Component #
Methods gobjectType :: Component -> IO GType #
IsObject Component #

IsComponent Component #

((~) * info (ResolveComponentMethod t Component), MethodInfo * info Component p) => IsLabel t (Component -> p) #
Methods fromLabel :: Proxy# Symbol t -> Component -> p #
((~) * info (ResolveComponentMethod t Component), MethodInfo * info Component p) => IsLabelProxy t (Component -> p) #
Methods fromLabelProxy :: Proxy Symbol t -> Component -> p #
HasAttributeList * Component #

type AttributeList Component #
type AttributeList Component
type SignalList Component #
type SignalList Component

noComponent :: Maybe Component #

class GObject o => IsComponent o #

Instances

(GObject a, UnknownAncestorError Constraint Component a) => IsComponent a #

IsComponent Component #

IsComponent Plug #

IsComponent Socket #

IsComponent NoOpObject #

toComponent :: (MonadIO m, IsComponent o) => o -> m Component #

Methods

contains

data ComponentContainsMethodInfo #

Instances

((~) * signature (Int32 -> Int32 -> CoordType -> m Bool), MonadIO m, IsComponent a) => MethodInfo * ComponentContainsMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentContainsMethodInfo a -> signature -> s #

componentContains #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: the `Component`
-> Int32	`x`: x coordinate
-> Int32	`y`: y coordinate
-> CoordType	`coordType`: specifies whether the coordinates are relative to the screen or to the components top level window
-> m Bool	Returns: `True` or `False` indicating whether the specified point is within the extent of the `component` or not

Checks whether the specified point is within the extent of the component.

Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it.

getAlpha

data ComponentGetAlphaMethodInfo #

Instances

((~) * signature (m Double), MonadIO m, IsComponent a) => MethodInfo * ComponentGetAlphaMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentGetAlphaMethodInfo a -> signature -> s #

componentGetAlpha #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: an `Component`
-> m Double	Returns: An alpha value from 0 to 1.0, inclusive.

Returns the alpha value (i.e. the opacity) for this component, on a scale from 0 (fully transparent) to 1.0 (fully opaque).

Since: 1.12

getExtents

data ComponentGetExtentsMethodInfo #

Instances

((~) * signature (CoordType -> m (Int32, Int32, Int32, Int32)), MonadIO m, IsComponent a) => MethodInfo * ComponentGetExtentsMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentGetExtentsMethodInfo a -> signature -> s #

componentGetExtents #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: an `Component`
-> CoordType	`coordType`: specifies whether the coordinates are relative to the screen or to the components top level window
-> m (Int32, Int32, Int32, Int32)

Gets the rectangle which gives the extent of the component.

getLayer

data ComponentGetLayerMethodInfo #

Instances

((~) * signature (m Layer), MonadIO m, IsComponent a) => MethodInfo * ComponentGetLayerMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentGetLayerMethodInfo a -> signature -> s #

componentGetLayer #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: an `Component`
-> m Layer	Returns: an `Layer` which is the layer of the component

Gets the layer of the component.

getMdiZorder

data ComponentGetMdiZorderMethodInfo #

Instances

((~) * signature (m Int32), MonadIO m, IsComponent a) => MethodInfo * ComponentGetMdiZorderMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentGetMdiZorderMethodInfo a -> signature -> s #

componentGetMdiZorder #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: an `Component`
-> m Int32	Returns: a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container.

Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.

getPosition

data ComponentGetPositionMethodInfo #

Instances

((~) * signature (CoordType -> m (Int32, Int32)), MonadIO m, IsComponent a) => MethodInfo * ComponentGetPositionMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentGetPositionMethodInfo a -> signature -> s #

componentGetPosition #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: an `Component`
-> CoordType	`coordType`: specifies whether the coordinates are relative to the screen or to the components top level window
-> m (Int32, Int32)

Deprecated: Since 2.12. Use componentGetExtents instead.

Gets the position of component in the form of a point specifying component's top-left corner.

getSize

data ComponentGetSizeMethodInfo #

Instances

((~) * signature (m (Int32, Int32)), MonadIO m, IsComponent a) => MethodInfo * ComponentGetSizeMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentGetSizeMethodInfo a -> signature -> s #

componentGetSize #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: an `Component`
-> m (Int32, Int32)

Deprecated: Since 2.12. Use componentGetExtents instead.

Gets the size of the component in terms of width and height.

grabFocus

data ComponentGrabFocusMethodInfo #

Instances

((~) * signature (m Bool), MonadIO m, IsComponent a) => MethodInfo * ComponentGrabFocusMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentGrabFocusMethodInfo a -> signature -> s #

componentGrabFocus #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: an `Component`
-> m Bool	Returns: `True` if successful, `False` otherwise.

Grabs focus for this component.

refAccessibleAtPoint

data ComponentRefAccessibleAtPointMethodInfo #

Instances

((~) * signature (Int32 -> Int32 -> CoordType -> m (Maybe Object)), MonadIO m, IsComponent a) => MethodInfo * ComponentRefAccessibleAtPointMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentRefAccessibleAtPointMethodInfo a -> signature -> s #

componentRefAccessibleAtPoint #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: the `Component`
-> Int32	`x`: x coordinate
-> Int32	`y`: y coordinate
-> CoordType	`coordType`: specifies whether the coordinates are relative to the screen or to the components top level window
-> m (Maybe Object)	Returns: a reference to the accessible child, if one exists

Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y.

removeFocusHandler

data ComponentRemoveFocusHandlerMethodInfo #

Instances

((~) * signature (Word32 -> m ()), MonadIO m, IsComponent a) => MethodInfo * ComponentRemoveFocusHandlerMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentRemoveFocusHandlerMethodInfo a -> signature -> s #

componentRemoveFocusHandler #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: the `Component` to remove the focus handler from
-> Word32	`handlerId`: the handler id of the focus handler to be removed from `component`
-> m ()

Deprecated: (Since version 2.9.4)If you need to track when an object gains orlose the focus, use the Object::state-change "focused" notification instead.

Remove the handler specified by handlerId from the list of functions to be executed when this object receives focus events (in or out).

setExtents

data ComponentSetExtentsMethodInfo #

Instances

((~) * signature (Int32 -> Int32 -> Int32 -> Int32 -> CoordType -> m Bool), MonadIO m, IsComponent a) => MethodInfo * ComponentSetExtentsMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentSetExtentsMethodInfo a -> signature -> s #

componentSetExtents #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: an `Component`
-> Int32	`x`: x coordinate
-> Int32	`y`: y coordinate
-> Int32	`width`: width to set for `component`
-> Int32	`height`: height to set for `component`
-> CoordType	`coordType`: specifies whether the coordinates are relative to the screen or to the components top level window
-> m Bool	Returns: `True` or `False` whether the extents were set or not

Sets the extents of component.

setPosition

data ComponentSetPositionMethodInfo #

Instances

((~) * signature (Int32 -> Int32 -> CoordType -> m Bool), MonadIO m, IsComponent a) => MethodInfo * ComponentSetPositionMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentSetPositionMethodInfo a -> signature -> s #

componentSetPosition #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: an `Component`
-> Int32	`x`: x coordinate
-> Int32	`y`: y coordinate
-> CoordType	`coordType`: specifies whether the coordinates are relative to the screen or to the components top level window
-> m Bool	Returns: `True` or `False` whether or not the position was set or not

Sets the postition of component.

setSize

data ComponentSetSizeMethodInfo #

Instances

((~) * signature (Int32 -> Int32 -> m Bool), MonadIO m, IsComponent a) => MethodInfo * ComponentSetSizeMethodInfo a signature #
Methods overloadedMethod :: MethodProxy ComponentSetSizeMethodInfo a -> signature -> s #

componentSetSize #

Arguments

:: (HasCallStack, MonadIO m, IsComponent a)
=> a	`component`: an `Component`
-> Int32	`width`: width to set for `component`
-> Int32	`height`: height to set for `component`
-> m Bool	Returns: `True` or `False` whether the size was set or not

Set the size of the component in terms of width and height.

Signals

boundsChanged

type C_ComponentBoundsChangedCallback = Ptr () -> Ptr Rectangle -> Ptr () -> IO () #

type ComponentBoundsChangedCallback = Rectangle -> IO () #

data ComponentBoundsChangedSignalInfo #

Instances

afterComponentBoundsChanged :: (IsComponent a, MonadIO m) => a -> ComponentBoundsChangedCallback -> m SignalHandlerId #

genClosure_ComponentBoundsChanged :: ComponentBoundsChangedCallback -> IO Closure #

mk_ComponentBoundsChangedCallback :: C_ComponentBoundsChangedCallback -> IO (FunPtr C_ComponentBoundsChangedCallback) #

noComponentBoundsChangedCallback :: Maybe ComponentBoundsChangedCallback #

onComponentBoundsChanged :: (IsComponent a, MonadIO m) => a -> ComponentBoundsChangedCallback -> m SignalHandlerId #

wrap_ComponentBoundsChangedCallback :: ComponentBoundsChangedCallback -> Ptr () -> Ptr Rectangle -> Ptr () -> IO () #

SignalInfo ComponentBoundsChangedSignalInfo #
Associated Types type HaskellCallbackType ComponentBoundsChangedSignalInfo :: * # Methods connectSignal :: GObject o => SignalProxy o ComponentBoundsChangedSignalInfo -> o -> HaskellCallbackType ComponentBoundsChangedSignalInfo -> SignalConnectMode -> IO SignalHandlerId #
type HaskellCallbackType ComponentBoundsChangedSignalInfo #
type HaskellCallbackType ComponentBoundsChangedSignalInfo = ComponentBoundsChangedCallback