sandey/blender
1
0
Fork 0
forked from bartvdbraak/blender
Code Pull Requests Activity

Comments: wmOperator.cancel & modal

Browse Source
This commit is contained in:
Campbell Barton 2017-03-16 06:37:09 +11:00
parent 68496c0b38
commit 375ede0f3f
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
source/blender/windowmanager/WM_types.h
View File

@ -542,7 +542,15 @@ typedef struct wmOperatorType {
* canceled due to some external reason, cancel is called * canceled due to some external reason, cancel is called
* - see defines below for return values */ * - see defines below for return values */
int (*invoke)(struct bContext *, struct wmOperator *, const struct wmEvent *) ATTR_WARN_UNUSED_RESULT; int (*invoke)(struct bContext *, struct wmOperator *, const struct wmEvent *) ATTR_WARN_UNUSED_RESULT;
/* Called when a modal operator is canceled (not used often).
* Internal cleanup can be done here if needed. */
void (*cancel)(struct bContext *, struct wmOperator *); void (*cancel)(struct bContext *, struct wmOperator *);
/* Modal is used for operators which continuously run, eg:
* fly mode, knife tool, circle select are all examples of modal operators.
* Modal operators can handle events which would normally access other operators,
* they keep running until they don't return `OPERATOR_RUNNING_MODAL`. */
int (*modal)(struct bContext *, struct wmOperator *, const struct wmEvent *) ATTR_WARN_UNUSED_RESULT; int (*modal)(struct bContext *, struct wmOperator *, const struct wmEvent *) ATTR_WARN_UNUSED_RESULT;
/* verify if the operator can be executed in the current context, note /* verify if the operator can be executed in the current context, note