Portability | portable (depends on GHC) |
---|---|
Stability | provisional |
Maintainer | gtk2hs-users@lists.sourceforge.net |
Safe Haskell | None |
Add tips to your widgets
- data Tooltips
- class ObjectClass o => TooltipsClass o
- castToTooltips :: GObjectClass obj => obj -> Tooltips
- gTypeTooltips :: GType
- toTooltips :: TooltipsClass o => o -> Tooltips
- tooltipsNew :: IO Tooltips
- tooltipsEnable :: TooltipsClass self => self -> IO ()
- tooltipsDisable :: TooltipsClass self => self -> IO ()
- tooltipsSetDelay :: TooltipsClass self => self -> Int -> IO ()
- tooltipsSetTip :: (TooltipsClass self, WidgetClass widget) => self -> widget -> String -> String -> IO ()
- tooltipsDataGet :: WidgetClass w => w -> IO (Maybe (Tooltips, String, String))
Detail
Tooltips are the messages that appear next to a widget when the mouse pointer is held over it for a short amount of time. They are especially helpful for adding more verbose descriptions of things such as buttons in a toolbar.
An individual tooltip belongs to a group of tooltips. A group is created
with a call to tooltipsNew
. Every tooltip in the group can then be turned
off with a call to tooltipsDisable
and enabled with tooltipsEnable
.
Class Hierarchy
Types
class ObjectClass o => TooltipsClass o Source
castToTooltips :: GObjectClass obj => obj -> TooltipsSource
toTooltips :: TooltipsClass o => o -> TooltipsSource
Constructors
tooltipsNew :: IO TooltipsSource
Create a new goup of Tooltips
.
Methods
tooltipsEnable :: TooltipsClass self => self -> IO ()Source
Allows the user to see your tooltips as they navigate your application.
tooltipsDisable :: TooltipsClass self => self -> IO ()Source
Causes all tooltips in tooltips
to become inactive. Any widgets that
have tips associated with that group will no longer display their tips until
they are enabled again with tooltipsEnable
.
:: TooltipsClass self | |
=> self | |
-> Int |
|
-> IO () |
Sets the time between the user moving the mouse over a widget and the widget's tooltip appearing.
- Warning: this function is deprecated and should not be used in newly-written code.
:: (TooltipsClass self, WidgetClass widget) | |
=> self | |
-> widget |
|
-> String |
|
-> String |
|
-> IO () |
Adds a tooltip containing the message tipText
to the specified
Widget
.
tooltipsDataGet :: WidgetClass w => w -> IO (Maybe (Tooltips, String, String))Source
Retrieves any Tooltips
previously associated with the given widget.