Move & rename uiLayoutOperatorButs to interface_templates.c
authorJulian Eisel <eiseljulian@gmail.com>
Sat, 21 Oct 2017 14:47:25 +0000 (16:47 +0200)
committerJulian Eisel <eiseljulian@gmail.com>
Sat, 21 Oct 2017 14:48:42 +0000 (16:48 +0200)
source/blender/editors/include/UI_interface.h
source/blender/editors/interface/interface_layout.c
source/blender/editors/interface/interface_templates.c
source/blender/editors/space_clip/clip_toolbar.c
source/blender/editors/space_file/file_panels.c
source/blender/editors/space_view3d/view3d_toolbar.c
source/blender/windowmanager/intern/wm_operators.c

index 890fe7209915dc37847068435db9ff56813e2656..303d689fee7c085f1458e4de45c331cf99f7a912 100644 (file)
@@ -829,9 +829,9 @@ void UI_exit(void);
 #define UI_ITEM_R_NO_BG         (1 << 7)
 #define UI_ITEM_R_IMMEDIATE     (1 << 8)
 
-/* uiLayoutOperatorButs flags */
-#define UI_LAYOUT_OP_SHOW_TITLE 1
-#define UI_LAYOUT_OP_SHOW_EMPTY 2
+/* uiTemplateOperatorPropertyButs flags */
+#define UI_TEMPLATE_OP_PROPS_SHOW_TITLE 1
+#define UI_TEMPLATE_OP_PROPS_SHOW_EMPTY 2
 
 /* used for transp checkers */
 #define UI_ALPHA_CHECKER_DARK 100
@@ -866,9 +866,6 @@ void uiLayoutSetFunc(uiLayout *layout, uiMenuHandleFunc handlefunc, void *argv);
 void uiLayoutSetContextPointer(uiLayout *layout, const char *name, struct PointerRNA *ptr);
 void uiLayoutContextCopy(uiLayout *layout, struct bContextStore *context);
 const char *uiLayoutIntrospect(uiLayout *layout); // XXX - testing
-void uiLayoutOperatorButs(const struct bContext *C, struct uiLayout *layout, struct wmOperator *op,
-                          bool (*check_prop)(struct PointerRNA *, struct PropertyRNA *),
-                          const char label_align, const short flag);
 struct MenuType *UI_but_menutype_get(uiBut *but);
 
 void uiLayoutSetOperatorContext(uiLayout *layout, int opcontext);
@@ -942,6 +939,9 @@ void uiTemplateImageInfo(uiLayout *layout, struct bContext *C, struct Image *ima
 void uiTemplateRunningJobs(uiLayout *layout, struct bContext *C);
 void UI_but_func_operator_search(uiBut *but);
 void uiTemplateOperatorSearch(uiLayout *layout);
+void uiTemplateOperatorPropertyButs(const struct bContext *C, uiLayout *layout, struct wmOperator *op,
+                                    bool (*check_prop)(struct PointerRNA *, struct PropertyRNA *),
+                                    const char label_align, const short flag);
 void uiTemplateHeader3D(uiLayout *layout, struct bContext *C);
 void uiTemplateEditModeSelection(uiLayout *layout, struct bContext *C);
 void uiTemplateReportsBanner(uiLayout *layout, struct bContext *C);
index cabfca1439299bbc03e5d6c65f14a03a32ccc487..2dc5b91a1121d796b834741b50f7fd723cdd770d 100644 (file)
@@ -64,8 +64,6 @@
 
 /************************ Structs and Defines *************************/
 
-// #define USE_OP_RESET_BUT  // we may want to make this optional, disable for now.
-
 #define UI_OPERATOR_ERROR_RET(_ot, _opname, return_statement)                 \
        if (ot == NULL) {                                                         \
                ui_item_disabled(layout, _opname);                                    \
@@ -3561,125 +3559,6 @@ const char *uiLayoutIntrospect(uiLayout *layout)
        return str;
 }
 
-#ifdef USE_OP_RESET_BUT
-static void ui_layout_operator_buts__reset_cb(bContext *UNUSED(C), void *op_pt, void *UNUSED(arg_dummy2))
-{
-       WM_operator_properties_reset((wmOperator *)op_pt);
-}
-#endif
-
-/* this function does not initialize the layout, functions can be called on the layout before and after */
-void uiLayoutOperatorButs(
-        const bContext *C, uiLayout *layout, wmOperator *op,
-        bool (*check_prop)(struct PointerRNA *, struct PropertyRNA *),
-        const char label_align, const short flag)
-{
-       if (!op->properties) {
-               IDPropertyTemplate val = {0};
-               op->properties = IDP_New(IDP_GROUP, &val, "wmOperatorProperties");
-       }
-
-       if (flag & UI_LAYOUT_OP_SHOW_TITLE) {
-               uiItemL(layout, RNA_struct_ui_name(op->type->srna), ICON_NONE);
-       }
-
-       /* poll() on this operator may still fail, at the moment there is no nice feedback when this happens
-        * just fails silently */
-       if (!WM_operator_repeat_check(C, op)) {
-               UI_block_lock_set(uiLayoutGetBlock(layout), true, "Operator can't' redo");
-
-               /* XXX, could give some nicer feedback or not show redo panel at all? */
-               uiItemL(layout, IFACE_("* Redo Unsupported *"), ICON_NONE);
-       }
-       else {
-               /* useful for macros where only one of the steps can't be re-done */
-               UI_block_lock_clear(uiLayoutGetBlock(layout));
-       }
-
-       /* menu */
-       if (op->type->flag & OPTYPE_PRESET) {
-               /* XXX, no simple way to get WM_MT_operator_presets.bl_label from python! Label remains the same always! */
-               PointerRNA op_ptr;
-               uiLayout *row;
-
-               uiLayoutGetBlock(layout)->ui_operator = op;
-
-               row = uiLayoutRow(layout, true);
-               uiItemM(row, (bContext *)C, "WM_MT_operator_presets", NULL, ICON_NONE);
-
-               wmOperatorType *ot = WM_operatortype_find("WM_OT_operator_preset_add", false);
-               op_ptr = uiItemFullO_ptr(row, ot, "", ICON_ZOOMIN, NULL, WM_OP_INVOKE_DEFAULT, UI_ITEM_O_RETURN_PROPS);
-               RNA_string_set(&op_ptr, "operator", op->type->idname);
-
-               op_ptr = uiItemFullO_ptr(row, ot, "", ICON_ZOOMOUT, NULL, WM_OP_INVOKE_DEFAULT, UI_ITEM_O_RETURN_PROPS);
-               RNA_string_set(&op_ptr, "operator", op->type->idname);
-               RNA_boolean_set(&op_ptr, "remove_active", true);
-       }
-
-       if (op->type->ui) {
-               op->layout = layout;
-               op->type->ui((bContext *)C, op);
-               op->layout = NULL;
-
-               /* UI_LAYOUT_OP_SHOW_EMPTY ignored */
-       }
-       else {
-               wmWindowManager *wm = CTX_wm_manager(C);
-               PointerRNA ptr;
-               int empty;
-
-               RNA_pointer_create(&wm->id, op->type->srna, op->properties, &ptr);
-
-               /* main draw call */
-               empty = uiDefAutoButsRNA(layout, &ptr, check_prop, label_align) == 0;
-
-               if (empty && (flag & UI_LAYOUT_OP_SHOW_EMPTY)) {
-                       uiItemL(layout, IFACE_("No Properties"), ICON_NONE);
-               }
-       }
-
-#ifdef USE_OP_RESET_BUT
-       /* its possible that reset can do nothing if all have PROP_SKIP_SAVE enabled
-        * but this is not so important if this button is drawn in those cases
-        * (which isn't all that likely anyway) - campbell */
-       if (op->properties->len) {
-               uiBlock *block;
-               uiBut *but;
-               uiLayout *col; /* needed to avoid alignment errors with previous buttons */
-
-               col = uiLayoutColumn(layout, false);
-               block = uiLayoutGetBlock(col);
-               but = uiDefIconTextBut(block, UI_BTYPE_BUT, 0, ICON_FILE_REFRESH, IFACE_("Reset"), 0, 0, UI_UNIT_X, UI_UNIT_Y,
-                                      NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Reset operator defaults"));
-               UI_but_func_set(but, ui_layout_operator_buts__reset_cb, op, NULL);
-       }
-#endif
-
-       /* set various special settings for buttons */
-       {
-               uiBlock *block = uiLayoutGetBlock(layout);
-               const bool is_popup = (block->flag & UI_BLOCK_KEEP_OPEN) != 0;
-               uiBut *but;
-
-               
-               for (but = block->buttons.first; but; but = but->next) {
-                       /* no undo for buttons for operator redo panels */
-                       UI_but_flag_disable(but, UI_BUT_UNDO);
-                       
-                       /* only for popups, see [#36109] */
-
-                       /* if button is operator's default property, and a text-field, enable focus for it
-                        *      - this is used for allowing operators with popups to rename stuff with fewer clicks
-                        */
-                       if (is_popup) {
-                               if ((but->rnaprop == op->type->prop) && (but->type == UI_BTYPE_TEXT)) {
-                                       UI_but_focus_on_enter_event(CTX_wm_window(C), but);
-                               }
-                       }
-               }
-       }
-}
-
 /* this is a bit of a hack but best keep it in one place at least */
 MenuType *UI_but_menutype_get(uiBut *but)
 {
index 430795d0ee19756e36a1fe2160ac380340d17972..c392464ec3e1a14e15ba3face50b3f8905bbc22c 100644 (file)
@@ -58,6 +58,7 @@
 #include "BKE_depsgraph.h"
 #include "BKE_global.h"
 #include "BKE_idcode.h"
+#include "BKE_idprop.h"
 #include "BKE_library.h"
 #include "BKE_linestyle.h"
 #include "BKE_main.h"
 
 #include "PIL_time.h"
 
+
+// #define USE_OP_RESET_BUT  // we may want to make this optional, disable for now.
+
+
 void UI_template_fix_linking(void)
 {
 }
@@ -3385,6 +3390,129 @@ void uiTemplateOperatorSearch(uiLayout *layout)
        UI_but_func_operator_search(but);
 }
 
+/************************* Operator Redo Properties Template **************************/
+
+#ifdef USE_OP_RESET_BUT
+static void ui_layout_operator_buts__reset_cb(bContext *UNUSED(C), void *op_pt, void *UNUSED(arg_dummy2))
+{
+       WM_operator_properties_reset((wmOperator *)op_pt);
+}
+#endif
+
+/**
+ * Draw Operator property buttons for redoing execution with different settings.
+ * This function does not initialize the layout, functions can be called on the layout before and after.
+ */
+void uiTemplateOperatorPropertyButs(
+        const bContext *C, uiLayout *layout, wmOperator *op,
+        bool (*check_prop)(struct PointerRNA *, struct PropertyRNA *),
+        const char label_align, const short flag)
+{
+       if (!op->properties) {
+               IDPropertyTemplate val = {0};
+               op->properties = IDP_New(IDP_GROUP, &val, "wmOperatorProperties");
+       }
+
+       if (flag & UI_TEMPLATE_OP_PROPS_SHOW_TITLE) {
+               uiItemL(layout, RNA_struct_ui_name(op->type->srna), ICON_NONE);
+       }
+
+       /* poll() on this operator may still fail, at the moment there is no nice feedback when this happens
+        * just fails silently */
+       if (!WM_operator_repeat_check(C, op)) {
+               UI_block_lock_set(uiLayoutGetBlock(layout), true, "Operator can't' redo");
+
+               /* XXX, could give some nicer feedback or not show redo panel at all? */
+               uiItemL(layout, IFACE_("* Redo Unsupported *"), ICON_NONE);
+       }
+       else {
+               /* useful for macros where only one of the steps can't be re-done */
+               UI_block_lock_clear(uiLayoutGetBlock(layout));
+       }
+
+       /* menu */
+       if (op->type->flag & OPTYPE_PRESET) {
+               /* XXX, no simple way to get WM_MT_operator_presets.bl_label from python! Label remains the same always! */
+               PointerRNA op_ptr;
+               uiLayout *row;
+
+               uiLayoutGetBlock(layout)->ui_operator = op;
+
+               row = uiLayoutRow(layout, true);
+               uiItemM(row, (bContext *)C, "WM_MT_operator_presets", NULL, ICON_NONE);
+
+               wmOperatorType *ot = WM_operatortype_find("WM_OT_operator_preset_add", false);
+               op_ptr = uiItemFullO_ptr(row, ot, "", ICON_ZOOMIN, NULL, WM_OP_INVOKE_DEFAULT, UI_ITEM_O_RETURN_PROPS);
+               RNA_string_set(&op_ptr, "operator", op->type->idname);
+
+               op_ptr = uiItemFullO_ptr(row, ot, "", ICON_ZOOMOUT, NULL, WM_OP_INVOKE_DEFAULT, UI_ITEM_O_RETURN_PROPS);
+               RNA_string_set(&op_ptr, "operator", op->type->idname);
+               RNA_boolean_set(&op_ptr, "remove_active", true);
+       }
+
+       if (op->type->ui) {
+               op->layout = layout;
+               op->type->ui((bContext *)C, op);
+               op->layout = NULL;
+
+               /* UI_LAYOUT_OP_SHOW_EMPTY ignored */
+       }
+       else {
+               wmWindowManager *wm = CTX_wm_manager(C);
+               PointerRNA ptr;
+               int empty;
+
+               RNA_pointer_create(&wm->id, op->type->srna, op->properties, &ptr);
+
+               /* main draw call */
+               empty = uiDefAutoButsRNA(layout, &ptr, check_prop, label_align) == 0;
+
+               if (empty && (flag & UI_TEMPLATE_OP_PROPS_SHOW_EMPTY)) {
+                       uiItemL(layout, IFACE_("No Properties"), ICON_NONE);
+               }
+       }
+
+#ifdef USE_OP_RESET_BUT
+       /* its possible that reset can do nothing if all have PROP_SKIP_SAVE enabled
+        * but this is not so important if this button is drawn in those cases
+        * (which isn't all that likely anyway) - campbell */
+       if (op->properties->len) {
+               uiBlock *block;
+               uiBut *but;
+               uiLayout *col; /* needed to avoid alignment errors with previous buttons */
+
+               col = uiLayoutColumn(layout, false);
+               block = uiLayoutGetBlock(col);
+               but = uiDefIconTextBut(block, UI_BTYPE_BUT, 0, ICON_FILE_REFRESH, IFACE_("Reset"), 0, 0, UI_UNIT_X, UI_UNIT_Y,
+                                      NULL, 0.0, 0.0, 0.0, 0.0, TIP_("Reset operator defaults"));
+               UI_but_func_set(but, ui_layout_operator_buts__reset_cb, op, NULL);
+       }
+#endif
+
+       /* set various special settings for buttons */
+       {
+               uiBlock *block = uiLayoutGetBlock(layout);
+               const bool is_popup = (block->flag & UI_BLOCK_KEEP_OPEN) != 0;
+               uiBut *but;
+
+               for (but = block->buttons.first; but; but = but->next) {
+                       /* no undo for buttons for operator redo panels */
+                       UI_but_flag_disable(but, UI_BUT_UNDO);
+
+                       /* only for popups, see [#36109] */
+
+                       /* if button is operator's default property, and a text-field, enable focus for it
+                        *      - this is used for allowing operators with popups to rename stuff with fewer clicks
+                        */
+                       if (is_popup) {
+                               if ((but->rnaprop == op->type->prop) && (but->type == UI_BTYPE_TEXT)) {
+                                       UI_but_focus_on_enter_event(CTX_wm_window(C), but);
+                               }
+                       }
+               }
+       }
+}
+
 /************************* Running Jobs Template **************************/
 
 #define B_STOPRENDER    1
index b042bbe8fea6c68a6ad04690c763185247866947..1504ce1a7bafb0edc3d4d3a6088d4942b6f98635 100644 (file)
@@ -193,7 +193,7 @@ void CLIP_OT_tools(wmOperatorType *ot)
 
 static void clip_panel_operator_redo_buts(const bContext *C, Panel *pa, wmOperator *op)
 {
-       uiLayoutOperatorButs(C, pa->layout, op, NULL, 'V', 0);
+       uiTemplateOperatorPropertyButs(C, pa->layout, op, NULL, 'V', 0);
 }
 
 static void clip_panel_operator_redo_header(const bContext *C, Panel *pa)
index 7acf2564fb212f2c5d7e4259601a5fb649eae0e0..1839e86151811016d77f9e139fd621bf0f78da7e 100644 (file)
@@ -88,7 +88,7 @@ static void file_panel_operator(const bContext *C, Panel *pa)
 
        UI_block_func_set(uiLayoutGetBlock(pa->layout), file_draw_check_cb, NULL, NULL);
 
-       uiLayoutOperatorButs(C, pa->layout, op, file_panel_check_prop, '\0', UI_LAYOUT_OP_SHOW_EMPTY);
+       uiTemplateOperatorPropertyButs(C, pa->layout, op, file_panel_check_prop, '\0', UI_TEMPLATE_OP_PROPS_SHOW_EMPTY);
 
        UI_block_func_set(uiLayoutGetBlock(pa->layout), NULL, NULL, NULL);
 }
index 62f605ab99c40097b9dd246ec4f2a8d3bac873bf..1d99fcfdd3a12fd71e935602f2ce54cca726abf6 100644 (file)
@@ -67,7 +67,7 @@
 
 static void view3d_panel_operator_redo_buts(const bContext *C, Panel *pa, wmOperator *op)
 {
-       uiLayoutOperatorButs(C, pa->layout, op, NULL, 'V', 0);
+       uiTemplateOperatorPropertyButs(C, pa->layout, op, NULL, 'V', 0);
 }
 
 static void view3d_panel_operator_redo_header(const bContext *C, Panel *pa)
index be952df23b112b710e7b54ada5d6f5d079099cb8..a2bcf6db7de668d9dc3da594fad1b762eca7c987 100644 (file)
@@ -1406,13 +1406,13 @@ static uiBlock *wm_block_create_redo(bContext *C, ARegion *ar, void *arg_op)
 
        if (op->type->flag & OPTYPE_MACRO) {
                for (op = op->macro.first; op; op = op->next) {
-                       uiLayoutOperatorButs(C, layout, op, NULL, 'H', UI_LAYOUT_OP_SHOW_TITLE);
+                       uiTemplateOperatorPropertyButs(C, layout, op, NULL, 'H', UI_TEMPLATE_OP_PROPS_SHOW_TITLE);
                        if (op->next)
                                uiItemS(layout);
                }
        }
        else {
-               uiLayoutOperatorButs(C, layout, op, NULL, 'H', UI_LAYOUT_OP_SHOW_TITLE);
+               uiTemplateOperatorPropertyButs(C, layout, op, NULL, 'H', UI_TEMPLATE_OP_PROPS_SHOW_TITLE);
        }
        
        UI_block_bounds_set_popup(block, 4, 0, 0);
@@ -1481,7 +1481,7 @@ static uiBlock *wm_block_dialog_create(bContext *C, ARegion *ar, void *userData)
 
        layout = UI_block_layout(block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 0, 0, data->width, data->height, 0, style);
        
-       uiLayoutOperatorButs(C, layout, op, NULL, 'H', UI_LAYOUT_OP_SHOW_TITLE);
+       uiTemplateOperatorPropertyButs(C, layout, op, NULL, 'H', UI_TEMPLATE_OP_PROPS_SHOW_TITLE);
        
        /* clear so the OK button is left alone */
        UI_block_func_set(block, NULL, NULL, NULL);
@@ -1520,7 +1520,7 @@ static uiBlock *wm_operator_ui_create(bContext *C, ARegion *ar, void *userData)
        layout = UI_block_layout(block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 0, 0, data->width, data->height, 0, style);
 
        /* since ui is defined the auto-layout args are not used */
-       uiLayoutOperatorButs(C, layout, op, NULL, 'V', 0);
+       uiTemplateOperatorPropertyButs(C, layout, op, NULL, 'V', 0);
 
        UI_block_func_set(block, NULL, NULL, NULL);