diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-04-29 06:45:49 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-04-29 06:45:49 +0300 |
commit | dc2ce40c9518ef8b57c39f18f93e2993c7cb3270 (patch) | |
tree | 34b186c198002668f0dbce69e2c4aab873de5391 /source/blender/editors/include/ED_screen_types.h | |
parent | 8b11b8b3cf470c4610a2de9a9deee0b81516727b (diff) |
Docs: expand action-zone type comments
Diffstat (limited to 'source/blender/editors/include/ED_screen_types.h')
-rw-r--r-- | source/blender/editors/include/ED_screen_types.h | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/source/blender/editors/include/ED_screen_types.h b/source/blender/editors/include/ED_screen_types.h index 3cbeab247ef..a584ce4cca0 100644 --- a/source/blender/editors/include/ED_screen_types.h +++ b/source/blender/editors/include/ED_screen_types.h @@ -108,15 +108,29 @@ typedef struct AZone { float alpha; } AZone; -/* actionzone type */ +/** Action-Zone Type: #AZone.type */ enum { - /* corner widgets for splitting areas */ + /** + * Corner widgets for: + * - Splitting areas. + * - Swapping areas (Ctrl). + * - Copying the area into a new window (Shift). + */ AZONE_AREA = 1, - /* when a region is collapsed, draw a handle to expose */ + /** + * Use for region show/hide state: + * - When a region is collapsed, draw a handle to expose. + * - When a region is expanded, use the the action zone to resize the region. + */ AZONE_REGION, - /* when in editor fullscreen draw a corner to go to normal mode */ + /** + * Used when in editor fullscreen draw a corner to return to normal mode. + */ AZONE_FULLSCREEN, - /* Hotspot azone around scrollbars to show/hide them. */ + /** + * Hotspot azone around scrollbars to show/hide them. + * Only show the scrull-bars when the cursor is close. + */ AZONE_REGION_SCROLL, }; |