2011-02-23 10:52:22 +00:00
|
|
|
/*
|
2009-06-30 06:27:48 +00:00
|
|
|
* 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
|
2018-06-01 18:19:39 +02:00
|
|
|
* of the License, or (at your option) any later version.
|
2009-06-30 06:27:48 +00:00
|
|
|
*
|
|
|
|
* 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,
|
2010-02-12 13:34:04 +00:00
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2009-06-30 06:27:48 +00:00
|
|
|
*
|
|
|
|
* The Original Code is Copyright (C) 2009 Blender Foundation.
|
|
|
|
* All rights reserved.
|
|
|
|
*/
|
|
|
|
|
2019-02-18 08:08:12 +11:00
|
|
|
/** \file
|
|
|
|
* \ingroup spfile
|
2011-02-27 20:29:51 +00:00
|
|
|
*/
|
|
|
|
|
2013-04-05 17:56:54 +00:00
|
|
|
#include "BLI_blenlib.h"
|
|
|
|
#include "BLI_utildefines.h"
|
2011-02-27 20:29:51 +00:00
|
|
|
|
2009-06-29 20:23:40 +00:00
|
|
|
#include "BKE_context.h"
|
|
|
|
#include "BKE_screen.h"
|
|
|
|
|
2015-08-16 17:32:01 +10:00
|
|
|
#include "BLT_translation.h"
|
2011-06-15 08:28:56 +00:00
|
|
|
|
2009-06-29 20:23:40 +00:00
|
|
|
#include "DNA_screen_types.h"
|
|
|
|
#include "DNA_space_types.h"
|
2010-11-06 18:54:15 +00:00
|
|
|
#include "DNA_userdef_types.h"
|
2009-06-29 20:23:40 +00:00
|
|
|
|
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
|
|
|
|
#include "RNA_access.h"
|
2018-07-26 09:59:56 +10:00
|
|
|
#include "RNA_define.h"
|
2009-06-29 20:23:40 +00:00
|
|
|
|
2015-02-11 00:09:45 +01:00
|
|
|
#include "ED_fileselect.h"
|
|
|
|
|
2009-06-29 20:23:40 +00:00
|
|
|
#include "UI_interface.h"
|
|
|
|
#include "UI_resources.h"
|
|
|
|
|
2009-07-28 16:46:14 +00:00
|
|
|
#include "WM_api.h"
|
|
|
|
#include "WM_types.h"
|
|
|
|
|
2009-06-29 20:23:40 +00:00
|
|
|
#include "file_intern.h"
|
|
|
|
#include "fsmenu.h"
|
|
|
|
|
|
|
|
#include <string.h>
|
|
|
|
|
2018-07-02 11:47:00 +02:00
|
|
|
static bool file_panel_operator_poll(const bContext *C, PanelType *UNUSED(pt))
|
2009-07-28 16:46:14 +00:00
|
|
|
{
|
2012-06-18 13:01:24 +00:00
|
|
|
SpaceFile *sfile = CTX_wm_space_file(C);
|
2009-07-28 16:46:14 +00:00
|
|
|
return (sfile && sfile->op);
|
2009-06-29 20:23:40 +00:00
|
|
|
}
|
|
|
|
|
2020-04-03 22:20:25 -05:00
|
|
|
static void file_panel_operator_header(const bContext *C, Panel *panel)
|
2009-07-28 16:46:14 +00:00
|
|
|
{
|
2012-06-18 13:01:24 +00:00
|
|
|
SpaceFile *sfile = CTX_wm_space_file(C);
|
|
|
|
wmOperator *op = sfile->op;
|
2009-07-28 16:46:14 +00:00
|
|
|
|
2020-04-03 22:20:25 -05:00
|
|
|
BLI_strncpy(panel->drawname, WM_operatortype_name(op->type, op->ptr), sizeof(panel->drawname));
|
2009-07-28 16:46:14 +00:00
|
|
|
}
|
2009-06-29 20:23:40 +00:00
|
|
|
|
2020-04-03 22:20:25 -05:00
|
|
|
static void file_panel_operator(const bContext *C, Panel *panel)
|
2009-06-29 20:23:40 +00:00
|
|
|
{
|
2012-06-18 13:01:24 +00:00
|
|
|
SpaceFile *sfile = CTX_wm_space_file(C);
|
|
|
|
wmOperator *op = sfile->op;
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-04-03 22:20:25 -05:00
|
|
|
UI_block_func_set(uiLayoutGetBlock(panel->layout), file_draw_check_cb, NULL, NULL);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2018-07-26 09:59:56 +10:00
|
|
|
/* Hack: temporary hide.*/
|
2018-07-29 12:12:36 +10:00
|
|
|
const char *hide[] = {"filepath", "files", "directory", "filename"};
|
2018-07-26 09:59:56 +10:00
|
|
|
for (int i = 0; i < ARRAY_SIZE(hide); i++) {
|
2018-07-28 22:58:33 +02:00
|
|
|
PropertyRNA *prop = RNA_struct_find_property(op->ptr, hide[i]);
|
|
|
|
if (prop) {
|
|
|
|
RNA_def_property_flag(prop, PROP_HIDDEN);
|
|
|
|
}
|
2018-07-26 09:59:56 +10:00
|
|
|
}
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2018-07-26 13:50:56 +10:00
|
|
|
uiTemplateOperatorPropertyButs(
|
2020-04-03 22:20:25 -05:00
|
|
|
C, panel->layout, op, UI_BUT_LABEL_ALIGN_NONE, UI_TEMPLATE_OP_PROPS_SHOW_EMPTY);
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2018-07-28 22:58:33 +02:00
|
|
|
/* Hack: temporary hide.*/
|
2018-07-26 09:59:56 +10:00
|
|
|
for (int i = 0; i < ARRAY_SIZE(hide); i++) {
|
2018-07-28 22:58:33 +02:00
|
|
|
PropertyRNA *prop = RNA_struct_find_property(op->ptr, hide[i]);
|
|
|
|
if (prop) {
|
|
|
|
RNA_def_property_clear_flag(prop, PROP_HIDDEN);
|
|
|
|
}
|
2018-07-26 09:59:56 +10:00
|
|
|
}
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2020-04-03 22:20:25 -05:00
|
|
|
UI_block_func_set(uiLayoutGetBlock(panel->layout), NULL, NULL, NULL);
|
2009-07-28 16:46:14 +00:00
|
|
|
}
|
2009-06-29 20:23:40 +00:00
|
|
|
|
2019-09-04 16:21:42 +02:00
|
|
|
void file_tool_props_region_panels_register(ARegionType *art)
|
2009-06-29 20:23:40 +00:00
|
|
|
{
|
|
|
|
PanelType *pt;
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2012-06-18 13:01:24 +00:00
|
|
|
pt = MEM_callocN(sizeof(PanelType), "spacetype file operator properties");
|
2009-06-29 20:23:40 +00:00
|
|
|
strcpy(pt->idname, "FILE_PT_operator");
|
2012-03-03 21:42:21 +00:00
|
|
|
strcpy(pt->label, N_("Operator"));
|
2015-08-16 17:32:01 +10:00
|
|
|
strcpy(pt->translation_context, BLT_I18NCONTEXT_DEFAULT_BPYRNA);
|
UI: File Browser Design Overhaul
This is a general redesign of the File Browser GUI and interaction
methods. For screenshots, check patch D5601.
Main changes in short:
* File Browser as floating window
* New layout of regions
* Popovers for view and filter options
* Vertical list view with interactive column header
* New and updated icons
* Keymap consistency fixes
* Many tweaks and fixes to the drawing of views
----
General:
* The file browser now opens as temporary floating window. It closes on
Esc. The header is hidden then.
* When the file browser is opened as regular editor, the header remains
visible.
* All file browser regions are now defined in Python (the button
layout).
* Adjusted related operator UI names.
Keymap:
Keymap is now consistent with other list-based views in Blender, such as
the Outliner.
* Left click to select, double-click to open
* Right-click context menus
* Shift-click to fill selection
* Ctrl-click to extend selection
Operator options:
These previously overlapped with the source list, which caused numerous
issues with resizing and presenting many settings in a small panel area.
It was also generally inconsistent with Blender.
* Moved to new sidebar, which can easily be shown or hidden using a
prominent Options toggle.
* IO operators have new layouts to match this new sidebar, using
sub-panels. This will have to be committed separately (Add-on
repository).
* If operators want to show the options by default, they have the option
to do so (see `WM_FILESEL_SHOW_PROPS`, `hide_props_region`), otherwise
they are hidden by default.
General Layout:
The layout has been changed to be simpler, more standard, and fits
better in with Blender 2.8.
* More conventional layout (file path at top, file name at the bottom,
execute/cancel buttons in bottom right).
* Use of popovers to group controls, and allow for more descriptive
naming.
* Search box is always live now, just like Outliner.
Views:
* Date Modified column combines both date and time, also uses user
friendly strings for recent dates (i.e. "Yesterday", "Today").
* Details columns (file size, modification date/time) are now toggleable
for all display types, they are not hardcoded per display type.
* File sizes now show as B, KB, MB, ... rather than B, KiB, MiB, … They
are now also calculated using base 10 of course.
* Option to sort in inverse order.
Vertical List View:
* This view now used a much simpler single vertical list with columns
for information.
* Users can click on the headers of these columns to order by that
category, and click again to reverse the ordering.
Icons:
* Updated icons by Jendrzych, with better centering.
* Files and folders have new icons in Icon view.
* Both files and folders have reworked superimposed icons that show
users the file/folder type.
* 3D file documents correctly use the 3d file icon, which was unused
previously.
* Workspaces now show their icon on Link/Append - also when listed in
the Outliner.
Minor Python-API breakage:
* `bpy.types.FileSelectParams.display_type`: `LIST_SHORT` and
`LIST_LONG` are replaced by `LIST_VERTICAL` and `LIST_HORIZONTAL`.
Removes the feature where directories would automatically be created if
they are entered into the file path text button, but don't exist. We
were not sure if users use it enough to keep it. We can definitely bring
it back.
----
//Combined effort by @billreynish, @harley, @jendrzych, my university
colleague Brian Meisenheimer and myself.//
Differential Revision: https://developer.blender.org/D5601
Reviewers: Brecht, Bastien
2019-09-03 15:43:38 +02:00
|
|
|
pt->flag = PANEL_TYPE_NO_HEADER;
|
2012-06-18 13:01:24 +00:00
|
|
|
pt->poll = file_panel_operator_poll;
|
|
|
|
pt->draw_header = file_panel_operator_header;
|
|
|
|
pt->draw = file_panel_operator;
|
2009-06-29 20:23:40 +00:00
|
|
|
BLI_addtail(&art->paneltypes, pt);
|
2009-07-09 19:49:04 +00:00
|
|
|
}
|
2019-09-04 16:21:42 +02:00
|
|
|
|
2019-09-19 16:14:47 +02:00
|
|
|
static void file_panel_execution_cancel_button(uiLayout *layout)
|
2019-09-04 16:21:42 +02:00
|
|
|
{
|
2019-09-19 16:14:47 +02:00
|
|
|
uiLayout *row = uiLayoutRow(layout, false);
|
|
|
|
uiLayoutSetScaleX(row, 0.8f);
|
|
|
|
uiLayoutSetFixedSize(row, true);
|
|
|
|
uiItemO(row, IFACE_("Cancel"), ICON_NONE, "FILE_OT_cancel");
|
|
|
|
}
|
|
|
|
|
|
|
|
static void file_panel_execution_execute_button(uiLayout *layout, const char *title)
|
|
|
|
{
|
|
|
|
uiLayout *row = uiLayoutRow(layout, false);
|
|
|
|
uiLayoutSetScaleX(row, 0.8f);
|
|
|
|
uiLayoutSetFixedSize(row, true);
|
|
|
|
/* Just a display hint. */
|
|
|
|
uiLayoutSetActiveDefault(row, true);
|
|
|
|
uiItemO(row, title, ICON_NONE, "FILE_OT_execute");
|
2019-09-04 16:21:42 +02:00
|
|
|
}
|
|
|
|
|
2020-04-03 22:20:25 -05:00
|
|
|
static void file_panel_execution_buttons_draw(const bContext *C, Panel *panel)
|
2019-09-04 16:21:42 +02:00
|
|
|
{
|
|
|
|
bScreen *screen = CTX_wm_screen(C);
|
|
|
|
SpaceFile *sfile = CTX_wm_space_file(C);
|
|
|
|
FileSelectParams *params = ED_fileselect_get_params(sfile);
|
2020-04-03 22:20:25 -05:00
|
|
|
uiBlock *block = uiLayoutGetBlock(panel->layout);
|
2019-09-04 16:21:42 +02:00
|
|
|
uiBut *but;
|
|
|
|
uiLayout *row;
|
2019-09-09 16:36:10 +02:00
|
|
|
PointerRNA params_rna_ptr, *but_extra_rna_ptr;
|
2019-09-04 16:21:42 +02:00
|
|
|
|
|
|
|
const bool overwrite_alert = file_draw_check_exists(sfile);
|
|
|
|
const bool windows_layout =
|
|
|
|
#ifdef _WIN32
|
|
|
|
true;
|
|
|
|
#else
|
|
|
|
false;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
RNA_pointer_create(&screen->id, &RNA_FileSelectParams, params, ¶ms_rna_ptr);
|
|
|
|
|
2020-04-03 22:20:25 -05:00
|
|
|
row = uiLayoutRow(panel->layout, false);
|
2019-09-04 16:21:42 +02:00
|
|
|
uiLayoutSetScaleY(row, 1.3f);
|
|
|
|
|
|
|
|
/* callbacks for operator check functions */
|
|
|
|
UI_block_func_set(block, file_draw_check_cb, NULL, NULL);
|
|
|
|
|
|
|
|
but = uiDefButR(block,
|
|
|
|
UI_BTYPE_TEXT,
|
|
|
|
-1,
|
|
|
|
"",
|
|
|
|
0,
|
|
|
|
0,
|
|
|
|
UI_UNIT_X * 5,
|
|
|
|
UI_UNIT_Y,
|
|
|
|
¶ms_rna_ptr,
|
|
|
|
"filename",
|
|
|
|
0,
|
|
|
|
0.0f,
|
|
|
|
(float)FILE_MAXFILE,
|
|
|
|
0,
|
|
|
|
0,
|
|
|
|
TIP_(overwrite_alert ? N_("File name, overwrite existing") : N_("File name")));
|
|
|
|
|
|
|
|
BLI_assert(!UI_but_flag_is_set(but, UI_BUT_UNDO));
|
|
|
|
BLI_assert(!UI_but_is_utf8(but));
|
|
|
|
|
|
|
|
UI_but_func_complete_set(but, autocomplete_file, NULL);
|
|
|
|
/* silly workaround calling NFunc to ensure this does not get called
|
|
|
|
* immediate ui_apply_but_func but only after button deactivates */
|
|
|
|
UI_but_funcN_set(but, file_filename_enter_handle, NULL, but);
|
|
|
|
|
2019-09-16 18:14:23 +02:00
|
|
|
if (params->flag & FILE_CHECK_EXISTING) {
|
2019-09-09 16:36:10 +02:00
|
|
|
but_extra_rna_ptr = UI_but_extra_operator_icon_add(
|
|
|
|
but, "FILE_OT_filenum", WM_OP_EXEC_REGION_WIN, ICON_REMOVE);
|
|
|
|
RNA_int_set(but_extra_rna_ptr, "increment", -1);
|
2020-10-21 17:34:53 +02:00
|
|
|
but_extra_rna_ptr = UI_but_extra_operator_icon_add(
|
|
|
|
but, "FILE_OT_filenum", WM_OP_EXEC_REGION_WIN, ICON_ADD);
|
|
|
|
RNA_int_set(but_extra_rna_ptr, "increment", 1);
|
2019-09-09 16:36:10 +02:00
|
|
|
}
|
|
|
|
|
2019-09-04 16:21:42 +02:00
|
|
|
/* check if this overrides a file and if the operator option is used */
|
|
|
|
if (overwrite_alert) {
|
|
|
|
UI_but_flag_enable(but, UI_BUT_REDALERT);
|
|
|
|
}
|
|
|
|
UI_block_func_set(block, NULL, NULL, NULL);
|
|
|
|
|
|
|
|
{
|
2019-09-19 16:14:47 +02:00
|
|
|
uiLayout *sub = uiLayoutRow(row, false);
|
|
|
|
uiLayoutSetOperatorContext(sub, WM_OP_EXEC_REGION_WIN);
|
|
|
|
|
2019-09-04 16:21:42 +02:00
|
|
|
if (windows_layout) {
|
2019-09-19 16:14:47 +02:00
|
|
|
file_panel_execution_execute_button(sub, params->title);
|
|
|
|
file_panel_execution_cancel_button(sub);
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
file_panel_execution_cancel_button(sub);
|
|
|
|
file_panel_execution_execute_button(sub, params->title);
|
2019-09-04 16:21:42 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void file_execute_region_panels_register(ARegionType *art)
|
|
|
|
{
|
|
|
|
PanelType *pt;
|
|
|
|
|
|
|
|
pt = MEM_callocN(sizeof(PanelType), "spacetype file execution buttons");
|
|
|
|
strcpy(pt->idname, "FILE_PT_execution_buttons");
|
|
|
|
strcpy(pt->label, N_("Execute Buttons"));
|
|
|
|
strcpy(pt->translation_context, BLT_I18NCONTEXT_DEFAULT_BPYRNA);
|
|
|
|
pt->flag = PANEL_TYPE_NO_HEADER;
|
|
|
|
pt->poll = file_panel_operator_poll;
|
|
|
|
pt->draw = file_panel_execution_buttons_draw;
|
|
|
|
BLI_addtail(&art->paneltypes, pt);
|
|
|
|
}
|