WM: correct description for header/status_text_set

Make text a required argument for both.
This commit is contained in:
Campbell Barton
2018-10-30 08:55:36 +11:00
parent 79ff9a0e19
commit 39a1d45279
2 changed files with 4 additions and 2 deletions

View File

@@ -332,7 +332,7 @@ static void rna_def_area_api(StructRNA *srna)
func = RNA_def_function(srna, "header_text_set", "ED_area_status_text");
RNA_def_function_ui_description(func, "Set the header status text");
parm = RNA_def_string(func, "text", NULL, 0, "Text", "New string for the header, no argument clears the text");
parm = RNA_def_string(func, "text", NULL, 0, "Text", "New string for the header, empty string clears the text");
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
}

View File

@@ -171,11 +171,13 @@ static PointerRNA rna_WorkspaceTool_gizmo_group_properties(
void RNA_api_workspace(StructRNA *srna)
{
FunctionRNA *func;
PropertyRNA *parm;
func = RNA_def_function(srna, "status_text_set", "ED_workspace_status_text");
RNA_def_function_flag(func, FUNC_NO_SELF | FUNC_USE_CONTEXT);
RNA_def_function_ui_description(func, "Set the status bar text, typically key shortcuts for modal operators");
RNA_def_string(func, "text", NULL, 0, "Text", "New string for the status bar, no argument clears the text");
parm = RNA_def_string(func, "text", NULL, 0, "Text", "New string for the status bar, empty string clears the text");
RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
}
void RNA_api_workspace_tool(StructRNA *srna)