ee8f69c96c
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
140 lines
5.7 KiB
C++
140 lines
5.7 KiB
C++
/*
|
|
* 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.
|
|
*
|
|
* The Original Code is Copyright (C) 2007 Blender Foundation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup spfile
|
|
*/
|
|
|
|
#ifndef __FILELIST_H__
|
|
#define __FILELIST_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct BlendHandle;
|
|
struct FileList;
|
|
struct FileSelection;
|
|
struct wmWindowManager;
|
|
|
|
struct FileDirEntry;
|
|
|
|
typedef enum FileSelType {
|
|
FILE_SEL_REMOVE = 0,
|
|
FILE_SEL_ADD = 1,
|
|
FILE_SEL_TOGGLE = 2,
|
|
} FileSelType;
|
|
|
|
typedef enum FileCheckType {
|
|
CHECK_DIRS = 1,
|
|
CHECK_FILES = 2,
|
|
CHECK_ALL = 3,
|
|
} FileCheckType;
|
|
|
|
struct ListBase *folderlist_new(void);
|
|
void folderlist_free(struct ListBase *folderlist);
|
|
struct ListBase *folderlist_duplicate(ListBase *folderlist);
|
|
void folderlist_popdir(struct ListBase *folderlist, char *dir);
|
|
void folderlist_pushdir(struct ListBase *folderlist, const char *dir);
|
|
const char *folderlist_peeklastdir(struct ListBase *folderdist);
|
|
int folderlist_clear_next(struct SpaceFile *sfile);
|
|
|
|
void filelist_setsorting(struct FileList *filelist, const short sort, bool invert_sort);
|
|
void filelist_sort(struct FileList *filelist);
|
|
|
|
void filelist_setfilter_options(struct FileList *filelist,
|
|
const bool do_filter,
|
|
const bool hide_dot,
|
|
const bool hide_parent,
|
|
const unsigned int filter,
|
|
const unsigned int filter_id,
|
|
const char *filter_glob,
|
|
const char *filter_search);
|
|
void filelist_filter(struct FileList *filelist);
|
|
|
|
void filelist_init_icons(void);
|
|
void filelist_free_icons(void);
|
|
void filelist_imgsize(struct FileList *filelist, short w, short h);
|
|
struct ImBuf *filelist_getimage(struct FileList *filelist, const int index);
|
|
struct ImBuf *filelist_geticon_image(struct FileList *filelist, const int index);
|
|
int filelist_geticon(struct FileList *filelist, const int index, const bool is_main);
|
|
|
|
struct FileList *filelist_new(short type);
|
|
void filelist_clear(struct FileList *filelist);
|
|
void filelist_clear_ex(struct FileList *filelist, const bool do_cache, const bool do_selection);
|
|
void filelist_free(struct FileList *filelist);
|
|
|
|
const char *filelist_dir(struct FileList *filelist);
|
|
bool filelist_is_dir(struct FileList *filelist, const char *path);
|
|
void filelist_setdir(struct FileList *filelist, char *r_dir);
|
|
|
|
int filelist_files_ensure(struct FileList *filelist);
|
|
int filelist_empty(struct FileList *filelist);
|
|
FileDirEntry *filelist_file(struct FileList *filelist, int index);
|
|
int filelist_file_findpath(struct FileList *filelist, const char *file);
|
|
FileDirEntry *filelist_entry_find_uuid(struct FileList *filelist, const int uuid[4]);
|
|
void filelist_file_cache_slidingwindow_set(struct FileList *filelist, size_t window_size);
|
|
bool filelist_file_cache_block(struct FileList *filelist, const int index);
|
|
|
|
bool filelist_force_reset(struct FileList *filelist);
|
|
bool filelist_pending(struct FileList *filelist);
|
|
bool filelist_is_ready(struct FileList *filelist);
|
|
|
|
unsigned int filelist_entry_select_set(const struct FileList *filelist,
|
|
const struct FileDirEntry *entry,
|
|
FileSelType select,
|
|
unsigned int flag,
|
|
FileCheckType check);
|
|
void filelist_entry_select_index_set(struct FileList *filelist,
|
|
const int index,
|
|
FileSelType select,
|
|
unsigned int flag,
|
|
FileCheckType check);
|
|
void filelist_entries_select_index_range_set(struct FileList *filelist,
|
|
FileSelection *sel,
|
|
FileSelType select,
|
|
unsigned int flag,
|
|
FileCheckType check);
|
|
unsigned int filelist_entry_select_get(struct FileList *filelist,
|
|
struct FileDirEntry *entry,
|
|
FileCheckType check);
|
|
unsigned int filelist_entry_select_index_get(struct FileList *filelist,
|
|
const int index,
|
|
FileCheckType check);
|
|
|
|
void filelist_setrecursion(struct FileList *filelist, const int recursion_level);
|
|
|
|
struct BlendHandle *filelist_lib(struct FileList *filelist);
|
|
bool filelist_islibrary(struct FileList *filelist, char *dir, char **group);
|
|
void filelist_freelib(struct FileList *filelist);
|
|
|
|
void filelist_readjob_start(struct FileList *filelist, const struct bContext *C);
|
|
void filelist_readjob_stop(struct wmWindowManager *wm, struct ScrArea *sa);
|
|
int filelist_readjob_running(struct wmWindowManager *wm, struct ScrArea *sa);
|
|
|
|
bool filelist_cache_previews_update(struct FileList *filelist);
|
|
void filelist_cache_previews_set(struct FileList *filelist, const bool use_previews);
|
|
bool filelist_cache_previews_running(struct FileList *filelist);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|