diff options
author | Campbell Barton <ideasman42@gmail.com> | 2018-01-25 13:49:31 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2018-01-25 13:52:40 +0300 |
commit | 2d46ea52cdd69f929ad7efe8e482cfc0a16de35f (patch) | |
tree | 8b4e31f1fbf994d287d3a5b401808426f71d01b8 /source/blender | |
parent | 7d66925c738b5a842ed212f4755a499e6ebdf95d (diff) |
WM: comments on wmTooltipState struct
Diffstat (limited to 'source/blender')
-rw-r--r-- | source/blender/windowmanager/WM_types.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/source/blender/windowmanager/WM_types.h b/source/blender/windowmanager/WM_types.h index ded96619a88..0f7d41295f1 100644 --- a/source/blender/windowmanager/WM_types.h +++ b/source/blender/windowmanager/WM_types.h @@ -690,12 +690,20 @@ typedef struct wmDropBox { } wmDropBox; +/** + * Struct to store tool-tip timer and possible creation if the time is reached. + * Allows UI code to call #WM_tooltip_timer_init without each user having to handle the timer. + */ typedef struct wmTooltipState { + /** Create tooltip on this event. */ struct wmTimer *timer; + /** The region the tooltip is created in. */ struct ARegion *region_from; + /** The tooltip region. */ struct ARegion *region; + /** Create the tooltip region (assign to 'region'). */ struct ARegion *(*init)(struct bContext *, struct ARegion *, bool *r_exit_on_event); - /* Exit on any event, not needed for buttons since their highlight state is used. */ + /** Exit on any event, not needed for buttons since their highlight state is used. */ bool exit_on_event; } wmTooltipState; |