path: root/source/blender/editors/interface/interface_context_menu.c

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

/** \file blender/editors/interface/interface_context_menu.c
 *  \ingroup edinterface
 *
 * Generic context popup menus.
 */

#include <string.h>

#include "MEM_guardedalloc.h"

#include "DNA_scene_types.h"
#include "DNA_screen_types.h"

#include "BLI_path_util.h"
#include "BLI_string.h"
#include "BLI_utildefines.h"

#include "BLT_translation.h"

#include "BKE_addon.h"
#include "BKE_context.h"
#include "BKE_idprop.h"
#include "BKE_screen.h"

#include "ED_screen.h"
#include "ED_keyframing.h"

#include "UI_interface.h"

#include "interface_intern.h"

#include "RNA_access.h"

#include "WM_api.h"
#include "WM_types.h"

/* This hack is needed because we don't have a good way to re-reference keymap items once added: T42944 */
#define USE_KEYMAP_ADD_HACK

/* -------------------------------------------------------------------- */
/** \name Button Context Menu
 * \{ */

static void but_shortcut_name_func(bContext *C, void *arg1, int UNUSED(event))
{
	uiBut *but = (uiBut *)arg1;

	if (but->optype) {
		char shortcut_str[128];

		IDProperty *prop = (but->opptr) ? but->opptr->data : NULL;

		/* complex code to change name of button */
		if (WM_key_event_operator_string(
		        C, but->optype->idname, but->opcontext, prop, true,
		        shortcut_str, sizeof(shortcut_str)))
		{
			ui_but_add_shortcut(but, shortcut_str, true);
		}
		else {
			/* simply strip the shortcut */
			ui_but_add_shortcut(but, NULL, true);
		}
	}
}

static uiBlock *menu_change_shortcut(bContext *C, ARegion *ar, void *arg)
{
	wmWindowManager *wm = CTX_wm_manager(C);
	uiBlock *block;
	uiBut *but = (uiBut *)arg;
	wmKeyMap *km;
	wmKeyMapItem *kmi;
	PointerRNA ptr;
	uiLayout *layout;
	uiStyle *style = UI_style_get_dpi();
	IDProperty *prop = (but->opptr) ? but->opptr->data : NULL;

	kmi = WM_key_event_operator(C, but->optype->idname, but->opcontext, prop, true, &km);
	BLI_assert(kmi != NULL);

	RNA_pointer_create(&wm->id, &RNA_KeyMapItem, kmi, &ptr);

	block = UI_block_begin(C, ar, "_popup", UI_EMBOSS);
	UI_block_func_handle_set(block, but_shortcut_name_func, but);
	UI_block_flag_enable(block, UI_BLOCK_MOVEMOUSE_QUIT);
	UI_block_direction_set(block, UI_DIR_CENTER_Y);

	layout = UI_block_layout(block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 0, 0, 200, 20, 0, style);

	uiItemR(layout, &ptr, "type", UI_ITEM_R_FULL_EVENT | UI_ITEM_R_IMMEDIATE, "", ICON_NONE);

	UI_block_bounds_set_popup(block, 6, -50, 26);

	return block;
}

#ifdef USE_KEYMAP_ADD_HACK
static int g_kmi_id_hack;
#endif

static uiBlock *menu_add_shortcut(bContext *C, ARegion *ar, void *arg)
{
	wmWindowManager *wm = CTX_wm_manager(C);
	uiBlock *block;
	uiBut *but = (uiBut *)arg;
	wmKeyMap *km;
	wmKeyMapItem *kmi;
	PointerRNA ptr;
	uiLayout *layout;
	uiStyle *style = UI_style_get_dpi();
	IDProperty *prop = (but->opptr) ? but->opptr->data : NULL;
	int kmi_id;

	/* XXX this guess_opname can potentially return a different keymap than being found on adding later... */
	km = WM_keymap_guess_opname(C, but->optype->idname);
	kmi = WM_keymap_add_item(km, but->optype->idname, AKEY, KM_PRESS, 0, 0);
	kmi_id = kmi->id;

	/* copy properties, prop can be NULL for reset */
	if (prop)
		prop = IDP_CopyProperty(prop);
	WM_keymap_properties_reset(kmi, prop);

	/* update and get pointers again */
	WM_keyconfig_update(wm);

	km = WM_keymap_guess_opname(C, but->optype->idname);
	kmi = WM_keymap_item_find_id(km, kmi_id);

	RNA_pointer_create(&wm->id, &RNA_KeyMapItem, kmi, &ptr);

	block = UI_block_begin(C, ar, "_popup", UI_EMBOSS);
	UI_block_func_handle_set(block, but_shortcut_name_func, but);
	UI_block_direction_set(block, UI_DIR_CENTER_Y);

	layout = UI_block_layout(block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 0, 0, 200, 20, 0, style);

	uiItemR(layout, &ptr, "type", UI_ITEM_R_FULL_EVENT | UI_ITEM_R_IMMEDIATE, "", ICON_NONE);

	UI_block_bounds_set_popup(block, 6, -50, 26);

#ifdef USE_KEYMAP_ADD_HACK
	g_kmi_id_hack = kmi_id;
#endif
	return block;
}

static void menu_add_shortcut_cancel(struct bContext *C, void *arg1)
{
	uiBut *but = (uiBut *)arg1;
	wmKeyMap *km;
	wmKeyMapItem *kmi;
#ifndef USE_KEYMAP_ADD_HACK
	IDProperty *prop;
#endif
	int kmi_id;

#ifdef USE_KEYMAP_ADD_HACK
	km = WM_keymap_guess_opname(C, but->optype->idname);
	kmi_id = g_kmi_id_hack;
	UNUSED_VARS(but);
#else
	prop  = (but->opptr) ? but->opptr->data : NULL;
	kmi_id = WM_key_event_operator_id(C, but->optype->idname, but->opcontext, prop, true, &km);
#endif

	kmi = WM_keymap_item_find_id(km, kmi_id);
	WM_keymap_remove_item(km, kmi);
}

static void popup_change_shortcut_func(bContext *C, void *arg1, void *UNUSED(arg2))
{
	uiBut *but = (uiBut *)arg1;
	UI_popup_block_invoke(C, menu_change_shortcut, but);
}

static void remove_shortcut_func(bContext *C, void *arg1, void *UNUSED(arg2))
{
	uiBut *but = (uiBut *)arg1;
	wmKeyMap *km;
	wmKeyMapItem *kmi;
	IDProperty *prop = (but->opptr) ? but->opptr->data : NULL;

	kmi = WM_key_event_operator(C, but->optype->idname, but->opcontext, prop, true, &km);
	BLI_assert(kmi != NULL);

	WM_keymap_remove_item(km, kmi);

	but_shortcut_name_func(C, but, 0);
}

static void popup_add_shortcut_func(bContext *C, void *arg1, void *UNUSED(arg2))
{
	uiBut *but = (uiBut *)arg1;
	UI_popup_block_ex(C, menu_add_shortcut, NULL, menu_add_shortcut_cancel, but, NULL);
}

static bool ui_but_is_user_menu_compatible(bContext *C, uiBut *but)
{
	return (but->optype ||
	        (but->rnaprop &&
	         (RNA_property_type(but->rnaprop) == PROP_BOOLEAN) &&
	         (WM_context_member_from_ptr(C, &but->rnapoin) != NULL)) ||
	        UI_but_menutype_get(but));
}

static bUserMenuItem *ui_but_user_menu_find(bContext *C, uiBut *but, bUserMenu *um)
{
	MenuType *mt = NULL;
	if (but->optype) {
		IDProperty *prop = (but->opptr) ? but->opptr->data : NULL;
		return (bUserMenuItem *)ED_screen_user_menu_item_find_operator(
		        &um->items, but->optype, prop, but->opcontext);
	}
	else if (but->rnaprop) {
		const char *member_id = WM_context_member_from_ptr(C, &but->rnapoin);
		const char *prop_id = RNA_property_identifier(but->rnaprop);
		return (bUserMenuItem *)ED_screen_user_menu_item_find_prop(
		        &um->items, member_id, prop_id, but->rnaindex);
	}
	else if ((mt = UI_but_menutype_get(but))) {
		return (bUserMenuItem *)ED_screen_user_menu_item_find_menu(
		        &um->items, mt);
	}
	else {
		return NULL;
	}
}

static void ui_but_user_menu_add(bContext *C, uiBut *but, bUserMenu *um)
{
	BLI_assert(ui_but_is_user_menu_compatible(C, but));

	char drawstr[sizeof(but->drawstr)];
	STRNCPY(drawstr, but->drawstr);
	if (but->flag & UI_BUT_HAS_SEP_CHAR) {
		char *sep = strrchr(drawstr, UI_SEP_CHAR);
		if (sep) {
			*sep = '\0';
		}
	}

	MenuType *mt = NULL;
	if (but->optype) {
		ED_screen_user_menu_item_add_operator(
		        &um->items, drawstr,
		        but->optype, but->opptr ? but->opptr->data : NULL, but->opcontext);
	}
	else if (but->rnaprop) {
		/* Note: 'member_id' may be a path. */
		const char *member_id = WM_context_member_from_ptr(C, &but->rnapoin);
		const char *data_path = RNA_path_from_ID_to_struct(&but->rnapoin);
		const char *member_id_data_path = member_id;
		if (data_path) {
			member_id_data_path = BLI_sprintfN("%s.%s", member_id, data_path);
		}
		const char *prop_id = RNA_property_identifier(but->rnaprop);
		/* Note, ignore 'drawstr', use property idname always. */
		ED_screen_user_menu_item_add_prop(
		        &um->items, "",
		        member_id_data_path, prop_id, but->rnaindex);
		if (data_path) {
			MEM_freeN((void *)data_path);
		}
		if (member_id != member_id_data_path) {
			MEM_freeN((void *)member_id_data_path);
		}
	}
	else if ((mt = UI_but_menutype_get(but))) {
		ED_screen_user_menu_item_add_menu(
		        &um->items, drawstr,
		        mt);
	}
}

static void popup_user_menu_add_or_replace_func(bContext *C, void *arg1, void *UNUSED(arg2))
{
	uiBut *but = arg1;
	bUserMenu *um = ED_screen_user_menu_ensure(C);
	ui_but_user_menu_add(C, but, um);
}

static void popup_user_menu_remove_func(bContext *UNUSED(C), void *arg1, void *arg2)
{
	bUserMenu *um = arg1;
	bUserMenuItem *umi = arg2;
	ED_screen_user_menu_item_remove(&um->items, umi);
}

static void ui_but_menu_add_path_operators(uiLayout *layout, PointerRNA *ptr, PropertyRNA *prop)
{
	const PropertySubType subtype = RNA_property_subtype(prop);
	wmOperatorType *ot = WM_operatortype_find("WM_OT_path_open", true);
	char filepath[FILE_MAX];
	char dir[FILE_MAXDIR];
	char file[FILE_MAXFILE];
	PointerRNA props_ptr;

	BLI_assert(ELEM(subtype, PROP_FILEPATH, PROP_DIRPATH));
	UNUSED_VARS_NDEBUG(subtype);

	RNA_property_string_get(ptr, prop, filepath);
	BLI_split_dirfile(filepath, dir, file, sizeof(dir), sizeof(file));

	if (file[0]) {
		BLI_assert(subtype == PROP_FILEPATH);
		uiItemFullO_ptr(
		        layout, ot, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Open File Externally"),
		        ICON_NONE, NULL, WM_OP_INVOKE_DEFAULT, 0, &props_ptr);
		RNA_string_set(&props_ptr, "filepath", filepath);
	}

	uiItemFullO_ptr(
	        layout, ot, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Open Location Externally"),
	        ICON_NONE, NULL, WM_OP_INVOKE_DEFAULT, 0, &props_ptr);
	RNA_string_set(&props_ptr, "filepath", dir);
}

bool ui_popup_context_menu_for_button(bContext *C, uiBut *but)
{
	/* having this menu for some buttons makes no sense */
	if (but->type == UI_BTYPE_IMAGE) {
		return false;
	}

	uiPopupMenu *pup;
	uiLayout *layout;

	{
		uiStringInfo label = {BUT_GET_LABEL, NULL};

		/* highly unlikely getting the label ever fails */
		UI_but_string_info_get(C, but, &label, NULL);

		pup = UI_popup_menu_begin(C, label.strinfo ? label.strinfo : "", ICON_NONE);
		layout = UI_popup_menu_layout(pup);
		if (label.strinfo) {
			MEM_freeN(label.strinfo);
		}
		uiLayoutSetOperatorContext(layout, WM_OP_INVOKE_DEFAULT);
	}

	if (but->rnapoin.data && but->rnaprop) {
		PointerRNA *ptr = &but->rnapoin;
		PropertyRNA *prop = but->rnaprop;
		const PropertyType type = RNA_property_type(prop);
		const PropertySubType subtype = RNA_property_subtype(prop);
		bool is_anim = RNA_property_animateable(ptr, prop);
		bool is_editable = RNA_property_editable(ptr, prop);
		/*bool is_idprop = RNA_property_is_idprop(prop);*/ /* XXX does not work as expected, not strictly needed */
		bool is_set = RNA_property_is_set(ptr, prop);

		/* second slower test, saved people finding keyframe items in menus when its not possible */
		if (is_anim)
			is_anim = RNA_property_path_from_ID_check(&but->rnapoin, but->rnaprop);

		/* determine if we can key a single component of an array */
		const bool is_array = RNA_property_array_length(&but->rnapoin, but->rnaprop) != 0;
		const bool is_array_component = (is_array && but->rnaindex != -1);

		const int override_status = RNA_property_static_override_status(ptr, prop, -1);
		const bool is_overridable = (override_status & RNA_OVERRIDE_STATUS_OVERRIDABLE) != 0;

		/* Keyframes */
		if (but->flag & UI_BUT_ANIMATED_KEY) {
			/* Set the (button_pointer, button_prop) and pointer data for Python access to the hovered ui element. */
			uiLayoutSetContextFromBut(layout, but);

			/* replace/delete keyfraemes */
			if (is_array_component) {
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Replace Keyframes"),
				        ICON_KEY_HLT, "ANIM_OT_keyframe_insert_button", "all", 1);
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Replace Single Keyframe"),
				        ICON_NONE, "ANIM_OT_keyframe_insert_button", "all", 0);
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Delete Keyframes"),
				        ICON_NONE, "ANIM_OT_keyframe_delete_button", "all", 1);
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Delete Single Keyframe"),
				        ICON_NONE, "ANIM_OT_keyframe_delete_button", "all", 0);
			}
			else {
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Replace Keyframe"),
				        ICON_KEY_HLT, "ANIM_OT_keyframe_insert_button", "all", 1);
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Delete Keyframe"),
				        ICON_NONE, "ANIM_OT_keyframe_delete_button", "all", 1);
			}

			/* keyframe settings */
			uiItemS(layout);


		}
		else if (but->flag & UI_BUT_DRIVEN) {
			/* pass */
		}
		else if (is_anim) {
			if (is_array_component) {
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Insert Keyframes"),
				        ICON_KEY_HLT, "ANIM_OT_keyframe_insert_button", "all", 1);
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Insert Single Keyframe"),
				        ICON_NONE, "ANIM_OT_keyframe_insert_button", "all", 0);
			}
			else {
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Insert Keyframe"),
				        ICON_KEY_HLT, "ANIM_OT_keyframe_insert_button", "all", 1);
			}
		}

		if ((but->flag & UI_BUT_ANIMATED) && (but->rnapoin.type != &RNA_NlaStrip)) {
			if (is_array_component) {
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Clear Keyframes"),
				        ICON_KEY_DEHLT, "ANIM_OT_keyframe_clear_button", "all", 1);
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Clear Single Keyframes"),
				        ICON_NONE, "ANIM_OT_keyframe_clear_button", "all", 0);
			}
			else {
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Clear Keyframes"),
				        ICON_KEY_DEHLT, "ANIM_OT_keyframe_clear_button", "all", 1);
			}
		}

		/* Drivers */
		if (but->flag & UI_BUT_DRIVEN) {
			uiItemS(layout);

			if (is_array_component) {
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Delete Drivers"),
				        ICON_X, "ANIM_OT_driver_button_remove", "all", 1);
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Delete Single Driver"),
				        ICON_NONE, "ANIM_OT_driver_button_remove", "all", 0);
			}
			else {
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Delete Driver"),
				        ICON_X, "ANIM_OT_driver_button_remove", "all", 1);
			}

			uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Copy Driver"),
			        ICON_NONE, "ANIM_OT_copy_driver_button");
			if (ANIM_driver_can_paste()) {
				uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Paste Driver"),
				        ICON_NONE, "ANIM_OT_paste_driver_button");
			}

			uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Edit Driver"),
			        ICON_DRIVER, "ANIM_OT_driver_button_edit");

			uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Open Drivers Editor"),
			        ICON_NONE, "SCREEN_OT_drivers_editor_show");
		}
		else if (but->flag & (UI_BUT_ANIMATED_KEY | UI_BUT_ANIMATED)) {
			/* pass */
		}
		else if (is_anim) {
			uiItemS(layout);

			uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Add Driver"),
			        ICON_DRIVER, "ANIM_OT_driver_button_add");

			if (ANIM_driver_can_paste()) {
				uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Paste Driver"),
				        ICON_NONE, "ANIM_OT_paste_driver_button");
			}

			uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Open Drivers Editor"),
			        ICON_NONE, "SCREEN_OT_drivers_editor_show");
		}

		/* Keying Sets */
		/* TODO: check on modifyability of Keying Set when doing this */
		if (is_anim) {
			uiItemS(layout);

			if (is_array_component) {
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Add All to Keying Set"),
				        ICON_KEYINGSET, "ANIM_OT_keyingset_button_add", "all", 1);
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Add Single to Keying Set"),
				        ICON_NONE, "ANIM_OT_keyingset_button_add", "all", 0);
				uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Remove from Keying Set"),
				        ICON_NONE, "ANIM_OT_keyingset_button_remove");
			}
			else {
				uiItemBooleanO(
				        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Add to Keying Set"),
				        ICON_KEYINGSET, "ANIM_OT_keyingset_button_add", "all", 1);
				uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Remove from Keying Set"),
				        ICON_NONE, "ANIM_OT_keyingset_button_remove");
			}
		}

		if (is_overridable) {
			wmOperatorType *ot;
			PointerRNA op_ptr;
			/* Override Operators */
			uiItemS(layout);

			if (but->flag & UI_BUT_OVERRIDEN) {
				if (is_array_component) {
#if 0  /* Disabled for now. */
					ot = WM_operatortype_find("UI_OT_override_type_set_button", false);
					uiItemFullO_ptr(
					        layout, ot, "Overrides Type", ICON_NONE,
					        NULL, WM_OP_INVOKE_DEFAULT, 0, &op_ptr);
					RNA_boolean_set(&op_ptr, "all", true);
					uiItemFullO_ptr(
					        layout, ot, "Single Override Type", ICON_NONE,
					        NULL, WM_OP_INVOKE_DEFAULT, 0, &op_ptr);
					RNA_boolean_set(&op_ptr, "all", false);
#endif
					uiItemBooleanO(
					        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Remove Overrides"),
					        ICON_X, "UI_OT_override_remove_button", "all", true);
					uiItemBooleanO(
					        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Remove Single Override"),
					        ICON_X, "UI_OT_override_remove_button", "all", false);
				}
				else {
#if 0  /* Disabled for now. */
					uiItemFullO(
					        layout, "UI_OT_override_type_set_button", "Override Type", ICON_NONE,
					        NULL, WM_OP_INVOKE_DEFAULT, 0, &op_ptr);
					RNA_boolean_set(&op_ptr, "all", false);
#endif
					uiItemBooleanO(
					        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Remove Override"),
					        ICON_X, "UI_OT_override_remove_button", "all", true);
				}
			}
			else {
				if (is_array_component) {
					ot = WM_operatortype_find("UI_OT_override_type_set_button", false);
					uiItemFullO_ptr(
					        layout, ot, "Define Overrides", ICON_NONE,
					        NULL, WM_OP_INVOKE_DEFAULT, 0, &op_ptr);
					RNA_boolean_set(&op_ptr, "all", true);
					uiItemFullO_ptr(
					        layout, ot, "Define Single Override", ICON_NONE,
					        NULL, WM_OP_INVOKE_DEFAULT, 0, &op_ptr);
					RNA_boolean_set(&op_ptr, "all", false);
				}
				else {
					uiItemFullO(
					        layout, "UI_OT_override_type_set_button", "Define Override", ICON_NONE,
					        NULL, WM_OP_INVOKE_DEFAULT, 0, &op_ptr);
					RNA_boolean_set(&op_ptr, "all", false);
				}
			}
		}

		uiItemS(layout);

		/* Property Operators */

		/* Copy Property Value
		 * Paste Property Value */

		if (is_array_component) {
			uiItemBooleanO(
			        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Reset All to Default Values"),
			        ICON_LOOP_BACK, "UI_OT_reset_default_button", "all", 1);
			uiItemBooleanO(
			        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Reset Single to Default Value"),
			        ICON_NONE, "UI_OT_reset_default_button", "all", 0);
		}
		else {
			uiItemBooleanO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Reset to Default Value"),
			        ICON_LOOP_BACK, "UI_OT_reset_default_button", "all", 1);
		}
		if (is_editable /*&& is_idprop*/ && is_set) {
			uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Unset"),
			        ICON_NONE, "UI_OT_unset_property_button");
		}

		if (is_array_component) {
			uiItemBooleanO(
			        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Copy All To Selected"),
			        ICON_NONE, "UI_OT_copy_to_selected_button", "all", true);
			uiItemBooleanO(
			        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Copy Single To Selected"),
			        ICON_NONE, "UI_OT_copy_to_selected_button", "all", false);
		}
		else {
			uiItemBooleanO(
			        layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Copy To Selected"),
			        ICON_NONE, "UI_OT_copy_to_selected_button", "all", true);
		}

		uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Copy Data Path"),
		        ICON_NONE, "UI_OT_copy_data_path_button");

		uiItemS(layout);

		if (type == PROP_STRING && ELEM(subtype, PROP_FILEPATH, PROP_DIRPATH)) {
			ui_but_menu_add_path_operators(layout, ptr, prop);
			uiItemS(layout);
		}
	}

	/* Operator buttons */
	if (but->optype) {
		uiBlock *block = uiLayoutGetBlock(layout);
		uiBut *but2;
		IDProperty *prop = (but->opptr) ? but->opptr->data : NULL;
		int w = uiLayoutGetWidth(layout);
		wmKeyMap *km;
		/* We want to know if this op has a shortcut, be it hotkey or not. */
		wmKeyMapItem *kmi = WM_key_event_operator(C, but->optype->idname, but->opcontext, prop, false, &km);

		/* We do have a shortcut, but only keyboard ones are editbale that way... */
		if (kmi) {
			if (ISKEYBOARD(kmi->type)) {
#if 0			/* would rather use a block but, but gets weirdly positioned... */
				uiDefBlockBut(
				        block, menu_change_shortcut, but, "Change Shortcut",
				        0, 0, uiLayoutGetWidth(layout), UI_UNIT_Y, "");
#endif

				but2 = uiDefIconTextBut(
				        block, UI_BTYPE_BUT, 0, ICON_HAND,
				        CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Change Shortcut"),
				        0, 0, w, UI_UNIT_Y, NULL, 0, 0, 0, 0, "");
				UI_but_func_set(but2, popup_change_shortcut_func, but, NULL);

				but2 = uiDefIconTextBut(
				        block, UI_BTYPE_BUT, 0, ICON_NONE,
				        CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Remove Shortcut"),
				        0, 0, w, UI_UNIT_Y, NULL, 0, 0, 0, 0, "");
				UI_but_func_set(but2, remove_shortcut_func, but, NULL);
			}
			else {
				but2 = uiDefIconTextBut(
				        block, UI_BTYPE_BUT, 0, ICON_HAND, IFACE_("Non-Keyboard Shortcut"),
				        0, 0, w, UI_UNIT_Y, NULL, 0, 0, 0, 0,
				        TIP_("Only keyboard shortcuts can be edited that way, "
				             "please use User Preferences otherwise"));
				UI_but_flag_enable(but2, UI_BUT_DISABLED);
			}
		}
		/* only show 'add' if there's a suitable key map for it to go in */
		else if (WM_keymap_guess_opname(C, but->optype->idname)) {
			but2 = uiDefIconTextBut(
			        block, UI_BTYPE_BUT, 0, ICON_HAND,
			        CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Add Shortcut"),
			        0, 0, w, UI_UNIT_Y, NULL, 0, 0, 0, 0, "");
			UI_but_func_set(but2, popup_add_shortcut_func, but, NULL);
		}

		/* Set the operator pointer for python access */
		uiLayoutSetContextFromBut(layout, but);

		uiItemS(layout);
	}

	/* Favorites Menu */
	if (ui_but_is_user_menu_compatible(C, but)) {
		uiBlock *block = uiLayoutGetBlock(layout);
		const int w = uiLayoutGetWidth(layout);
		uiBut *but2;

		but2 = uiDefIconTextBut(
		        block, UI_BTYPE_BUT, 0, ICON_MENU_PANEL,
		        CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Add to Favorites Menu"),
		        0, 0, w, UI_UNIT_Y, NULL, 0, 0, 0, 0,
		        "Add to a user defined context menu (stored in the user preferences)");
		UI_but_func_set(but2, popup_user_menu_add_or_replace_func, but, NULL);

		bUserMenu *um = ED_screen_user_menu_find(C);
		if (um) {
			bUserMenuItem *umi = ui_but_user_menu_find(C, but, um);
			if (umi != NULL) {
				but2 = uiDefIconTextBut(
				        block, UI_BTYPE_BUT, 0, ICON_CANCEL,
				        CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Remove from Favorites Menu"),
				        0, 0, w, UI_UNIT_Y, NULL, 0, 0, 0, 0, "");
				UI_but_func_set(but2, popup_user_menu_remove_func, um, umi);
			}
		}
		uiItemS(layout);
	}

	/* Show header tools for header buttons. */
	if (ui_block_is_popup_any(but->block) == false) {
		ARegion *ar = CTX_wm_region(C);
		if (ar && (ar->regiontype == RGN_TYPE_HEADER)) {
			uiItemMenuF(layout, IFACE_("Header"), ICON_NONE, ED_screens_header_tools_menu_create, NULL);
			uiItemS(layout);
		}
	}

	{   /* Docs */
		char buf[512];

		if (UI_but_online_manual_id(but, buf, sizeof(buf))) {
			PointerRNA ptr_props;
			uiItemO(layout, CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Online Manual"),
			        ICON_URL, "WM_OT_doc_view_manual_ui_context");

			uiItemFullO(
			        layout, "WM_OT_doc_view",
			        CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Online Python Reference"),
			        ICON_NONE, NULL, WM_OP_EXEC_DEFAULT, 0, &ptr_props);
			RNA_string_set(&ptr_props, "doc_id", buf);

			/* XXX inactive option, not for public! */
#if 0
			uiItemFullO(
			        layout, "WM_OT_doc_edit", "Submit Description", ICON_NONE,
			        NULL, WM_OP_INVOKE_DEFAULT, 0, &ptr_props);
			RNA_string_set(&ptr_props, "doc_id", buf);
			RNA_string_set(&ptr_props, "doc_new", RNA_property_description(but->rnaprop));
#endif
		}
	}

	if (but->optype) {
		uiItemO(layout, NULL,
		        ICON_NONE, "UI_OT_copy_python_command_button");
	}

	/* perhaps we should move this into (G.debug & G_DEBUG) - campbell */
	if (U.flag & USER_DEVELOPER_UI) {
		if (ui_block_is_menu(but->block) == false) {
			uiItemFullO(layout, "UI_OT_editsource", NULL, ICON_NONE, NULL, WM_OP_INVOKE_DEFAULT, 0, NULL);
		}
	}

	if (BKE_addon_find(&U.addons, "ui_translate")) {
		uiItemFullO(layout, "UI_OT_edittranslation_init", NULL, ICON_NONE, NULL, WM_OP_INVOKE_DEFAULT, 0, NULL);
	}

	MenuType *mt = WM_menutype_find("WM_MT_button_context", true);
	if (mt) {
		UI_menutype_draw(C, mt, uiLayoutColumn(layout, false));
	}

	return UI_popup_menu_end_or_cancel(C, pup);
}

/** \} */

/* -------------------------------------------------------------------- */
/** \name Panel Context Menu
 * \{ */

/**
 * menu to show when right clicking on the panel header
 */
void ui_popup_context_menu_for_panel(bContext *C, ARegion *ar, Panel *pa)
{
	bScreen *sc = CTX_wm_screen(C);
	const bool has_panel_category = UI_panel_category_is_visible(ar);
	const bool any_item_visible = has_panel_category;
	PointerRNA ptr;
	uiPopupMenu *pup;
	uiLayout *layout;

	if (!any_item_visible) {
		return;
	}

	RNA_pointer_create(&sc->id, &RNA_Panel, pa, &ptr);

	pup = UI_popup_menu_begin(C, IFACE_("Panel"), ICON_NONE);
	layout = UI_popup_menu_layout(pup);

	if (has_panel_category) {
		char tmpstr[80];
		BLI_snprintf(tmpstr, sizeof(tmpstr), "%s" UI_SEP_CHAR_S "%s", IFACE_("Pin"), IFACE_("Shift+Left Mouse"));
		uiItemR(layout, &ptr, "use_pin", 0, tmpstr, ICON_NONE);

		/* evil, force shortcut flag */
		{
			uiBlock *block = uiLayoutGetBlock(layout);
			uiBut *but = block->buttons.last;
			but->flag |= UI_BUT_HAS_SEP_CHAR;
		}
	}
	UI_popup_menu_end(C, pup);
}

/** \} */