[Bf-blender-cvs] [51f0c3fadf0] master: UI: move tooltip API to public header

Campbell Barton noreply at git.blender.org
Wed Dec 20 04:59:29 CET 2017


Commit: 51f0c3fadf085b087a9f98a59db41af6aa632a57
Author: Campbell Barton
Date:   Wed Dec 20 14:50:39 2017 +1100
Branches: master
https://developer.blender.org/rB51f0c3fadf085b087a9f98a59db41af6aa632a57

UI: move tooltip API to public header

===================================================================

M	source/blender/editors/include/UI_interface.h
M	source/blender/editors/interface/interface_handlers.c
M	source/blender/editors/interface/interface_intern.h
M	source/blender/editors/interface/interface_region_tooltip.c

===================================================================

diff --git a/source/blender/editors/include/UI_interface.h b/source/blender/editors/include/UI_interface.h
index 0e936fdd313..c20a61abea5 100644
--- a/source/blender/editors/include/UI_interface.h
+++ b/source/blender/editors/include/UI_interface.h
@@ -1110,6 +1110,12 @@ void UI_butstore_register(uiButStore *bs_handle, uiBut **but_p);
 bool UI_butstore_register_update(uiBlock *block, uiBut *but_dst, const uiBut *but_src);
 void UI_butstore_unregister(uiButStore *bs_handle, uiBut **but_p);
 
+/* ui_interface_region_tooltip.c */
+struct ARegion *UI_tooltip_create_from_button(struct bContext *C, struct ARegion *butregion, uiBut *but);
+void UI_tooltip_free(struct bContext *C, struct ARegion *ar);
+
+/* How long before a tool-tip shows. */
+#define UI_TOOLTIP_DELAY 0.5
 
 /* Float precision helpers */
 #define UI_PRECISION_FLOAT_MAX 6
diff --git a/source/blender/editors/interface/interface_handlers.c b/source/blender/editors/interface/interface_handlers.c
index f4f4aeab134..85cc05962c8 100644
--- a/source/blender/editors/interface/interface_handlers.c
+++ b/source/blender/editors/interface/interface_handlers.c
@@ -130,7 +130,6 @@ static bool ui_mouse_motion_keynav_test(struct uiKeyNavLock *keynav, const wmEve
 
 /***************** structs and defines ****************/
 
-#define BUTTON_TOOLTIP_DELAY        0.500
 #define BUTTON_FLASH_DELAY          0.020
 #define MENU_SCROLL_INTERVAL        0.1
 #define PIE_MENU_INTERVAL           0.01
@@ -7648,8 +7647,8 @@ void UI_but_tooltip_refresh(bContext *C, uiBut *but)
 
 	data = but->active;
 	if (data && data->tooltip) {
-		ui_tooltip_free(C, data->tooltip);
-		data->tooltip = ui_tooltip_create_from_button(C, data->region, but);
+		UI_tooltip_free(C, data->tooltip);
+		data->tooltip = UI_tooltip_create_from_button(C, data->region, but);
 	}
 }
 
@@ -7666,7 +7665,7 @@ void UI_but_tooltip_timer_remove(bContext *C, uiBut *but)
 			data->tooltiptimer = NULL;
 		}
 		if (data->tooltip) {
-			ui_tooltip_free(C, data->tooltip);
+			UI_tooltip_free(C, data->tooltip);
 			data->tooltip = NULL;
 		}
 
@@ -7692,7 +7691,7 @@ static void button_tooltip_timer_reset(bContext *C, uiBut *but)
 	if ((U.flag & USER_TOOLTIPS) || (data->tooltip_force)) {
 		if (!but->block->tooltipdisabled) {
 			if (!wm->drags.first) {
-				data->tooltiptimer = WM_event_add_timer(data->wm, data->window, TIMER, BUTTON_TOOLTIP_DELAY);
+				data->tooltiptimer = WM_event_add_timer(data->wm, data->window, TIMER, UI_TOOLTIP_DELAY);
 			}
 		}
 	}
@@ -8393,7 +8392,7 @@ static int ui_handle_button_event(bContext *C, const wmEvent *event, uiBut *but)
 					data->tooltiptimer = NULL;
 
 					if (!data->tooltip)
-						data->tooltip = ui_tooltip_create_from_button(C, data->region, but);
+						data->tooltip = UI_tooltip_create_from_button(C, data->region, but);
 				}
 				/* handle menu auto open timer */
 				else if (event->customdata == data->autoopentimer) {
diff --git a/source/blender/editors/interface/interface_intern.h b/source/blender/editors/interface/interface_intern.h
index fec07a39cf9..d5e89357a9f 100644
--- a/source/blender/editors/interface/interface_intern.h
+++ b/source/blender/editors/interface/interface_intern.h
@@ -587,8 +587,7 @@ struct uiPopupBlockHandle {
 /* interface_region_*.c */
 
 /* interface_region_tooltip.c */
-struct ARegion *ui_tooltip_create_from_button(struct bContext *C, struct ARegion *butregion, uiBut *but);
-void ui_tooltip_free(struct bContext *C, struct ARegion *ar);
+/* exposed as public API in UI_interface.h */
 
 /* interface_region_color_picker.c */
 void ui_rgb_to_color_picker_compat_v(const float rgb[3], float r_cp[3]);
diff --git a/source/blender/editors/interface/interface_region_tooltip.c b/source/blender/editors/interface/interface_region_tooltip.c
index 523e03cb8a5..8186e247a47 100644
--- a/source/blender/editors/interface/interface_region_tooltip.c
+++ b/source/blender/editors/interface/interface_region_tooltip.c
@@ -721,7 +721,7 @@ static ARegion *ui_tooltip_create_with_data(
  * \{ */
 
 
-ARegion *ui_tooltip_create_from_button(bContext *C, ARegion *butregion, uiBut *but)
+ARegion *UI_tooltip_create_from_button(bContext *C, ARegion *butregion, uiBut *but)
 {
 	wmWindow *win = CTX_wm_window(C);
 	/* aspect values that shrink text are likely unreadable */
@@ -751,7 +751,7 @@ ARegion *ui_tooltip_create_from_button(bContext *C, ARegion *butregion, uiBut *b
 	return ui_tooltip_create_with_data(C, data, init_position, aspect);
 }
 
-void ui_tooltip_free(bContext *C, ARegion *ar)
+void UI_tooltip_free(bContext *C, ARegion *ar)
 {
 	ui_region_temp_remove(C, CTX_wm_screen(C), ar);
 }



More information about the Bf-blender-cvs mailing list