griefith/test2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
Files
fba76712051331ab15272bcf1fe4e654775e4bdc
test2/source/blender/editors/include/UI_interface_c.hh

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

3360 lines
124 KiB
C++
Raw Normal View History

Cleanup: Add a copyright notice to files and use SPDX format A lot of files were missing copyright field in the header and the Blender Foundation contributed to them in a sense of bug fixing and general maintenance. This change makes it explicit that those files are at least partially copyrighted by the Blender Foundation. Note that this does not make it so the Blender Foundation is the only holder of the copyright in those files, and developers who do not have a signed contract with the foundation still hold the copyright as well. Another aspect of this change is using SPDX format for the header. We already used it for the license specification, and now we state it for the copyright as well, following the FAQ: https://reuse.software/faq/
2023-05-31 16:19:06 +02:00
/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
*
* SPDX-License-Identifier: GPL-2.0-or-later */
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
doxygen: add newline after \file While \file doesn't need an argument, it can't have another doxy command after it.
2019-02-18 08:08:12 +11:00
/** \file
* \ingroup editorui
doxygen: editor entry
2011-02-21 07:25:24 +00:00
*/
unify include guard defines, __$FILENAME__ without the underscores these clogged up the namespace for autocompleation which was annoying.
2012-02-17 18:59:41 +00:00
#pragma once
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
#include <functional>
#include <string>
UI: Refactor quick label tooltip implementation for buttons No user visible changes expected. Used in the asset shelf branch, see #104831. These tooltips only show a label string and appear after a shorter timeout than the regular tooltips. After the regular tooltip timeout they expand to the full tooltip. The toolbar and properties editor navigation tabs make use of this already. The changes here enable more control over quick label tooltips, making them usable in more cases, and less ad-hoc. Main changes: - Refactors internal logic so a single `UI_BUT_HAS_TOOLTIP_LABEL` button flag can be used to enable quick label tooltips. This decentralizes logic in a way that's more consistent and extensible. - Custom callback to return a quick label. This is useful when a label tooltip should be displayed even when there is no button string set. E.g. in the asset shelf with "Show Names" disabled. Pull Request: https://projects.blender.org/blender/blender/pulls/110200
2023-07-25 16:22:31 +02:00
Move GCC attributes into a centraized defines Instead of having ifdef __GNUC__ all over the headers to use special compiler's hints use a special file where all things like this are concentrated. Makes code easier to follow and allows to manage special attributes in more efficient way. Thanks Campbell for review!
2013-09-01 15:01:15 +00:00
#include "BLI_compiler_attrs.h"
UI: Remove panel name size limit for complex character languages The previous limit of 63 bytes for the panel name was an issue for languages where characters use multiple bytes. The UI would show panel names truncated that had reasonably long/short names. It's easy to support dynamically sized strings here, so do that instead of using fixed size buffers. Fixes #111927. Pull Request: https://projects.blender.org/blender/blender/pulls/111979
2023-09-12 14:47:46 +02:00
#include "BLI_string_ref.hh"
Refactor: UTF-8 Character Defines Use defined UTF-8 Universal character names in place of byte escape sequences and literals. Pull Request: https://projects.blender.org/blender/blender/pulls/109163
2023-06-26 06:05:18 +02:00
#include "BLI_string_utf8_symbols.h"
move BLO_sys_types.h -> BLI_sys_types.h (it had nothing todo with loading) remove MEM_sys_types.h which was a duplicate.
2013-05-28 19:35:26 +00:00
#include "BLI_sys_types.h" /* size_t */
UI: UI list refactor & preparations for asset view template This is more of a first-pass refactor for the UI list template. More improvements could be done, but that's better done separately. Main purpose of this is to make the UI list code more manageable and ready for the asset view template. No functional changes for users. * Split the huge template function into more manageable functions, with clear names and a few structs with high coherency. * Move runtime data management to the template code, with a free callback called from BKE. This is UI data and should be managed at that level. * Replace boolean arguments with bit-flags (easily extendable and more readable from the caller). * Allow passing custom-data to the UI list for callbacks to access. * Make list grip button for resizing optional. * Put logic for generating the internal UI list identifier (stored in .blends) into function. This is a quite important bit and a later commit adds a related function. Good to have a clear API for this. * Improve naming, comments, etc. As part of further cleanups I'd like to move this to an own file.
2021-07-14 16:01:53 +02:00
#include "BLI_utildefines.h"
Cleanup: Move editors headers to C++ See #103343 Pull Request: https://projects.blender.org/blender/blender/pulls/110820
2023-08-05 02:57:52 +02:00
#include "UI_interface_icons.hh"
Cleanup: Move WM headers to C++ Also move a few more headers that included WM headers. Pull Request: https://projects.blender.org/blender/blender/pulls/110815
2023-08-04 23:11:22 +02:00
#include "WM_types.hh"
2.5: UI * List template visual changes. Items now look different, and it expands to size 5 as more items are added. * Added LISTROW and LISTBOX elements. The former is like a typical ROW button, but looks diffrent. The latter looks like a BOUNDBOX, and has no extra features yet. * Fix some glColor3ubv warnings with casting, did not find a nicer way.
2009-07-21 01:26:17 +00:00
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
/* Struct Declarations */
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
struct ARegion;
UI/Assets: Initial Asset View UI template The asset view UI template is a mini-version of the Asset Browser that can be placed in regular layouts, regions or popups. At this point it's made specifically for placement in vertical layouts, it can be made more flexible in the future. Generally the way this is implemented will likely change a lot still as the asset system evolves. The Pose Library add-on will use the asset view to display pose libraries in the 3D View sidebar. References: * https://developer.blender.org/T86139 * https://code.blender.org/2021/06/asset-browser-project-update/#what-are-we-building * https://code.blender.org/2021/05/pose-library-v2-0/#use-from-3d-viewport Notes: * Important limitation: Due to the early & WIP implementation of the asset list, all asset views showing the same library will show the same assets. That is despite the ID type filter option the template provides. The first asset view created will determine what's visible. Of course this should be made to work eventually. * The template supports passing an activate and a drag operator name. The former is called when an asset is clicked on (e.g. to apply the asset) the latter when dragging (e.g. to .blend a pose asset). If no drag operator is set, regular asset drag & drop will be executed. * The template returns the properties for both operators (see example below). * The argument list for using the template is quite long, but we can't avoid that currently. The UI list design requires that we pass a number of RNA or custom properties to work with, that for the Pose Libraries should be registered at the Pose Library add-on level, not in core Blender. * Idea is that Python scripts or add-ons that want to use the asset view can register custom properties, to hold data like the list of assets, and the active asset index. Maybe that will change in future and we can manage these internally. As an example, the pose library add-on uses it like this: ``` activate_op_props, drag_op_props = layout.template_asset_view( "pose_assets", workspace, "active_asset_library", wm, "pose_assets", workspace, "active_pose_asset_index", filter_id_types={"filter_action"}, activate_operator="poselib.apply_pose_asset", drag_operator="poselib.blend_pose_asset", ) drag_op_props.release_confirm = True drag_op_props.flipped = wm.poselib_flipped activate_op_props.flipped = wm.poselib_flipped ```
2021-07-13 18:07:57 +02:00
struct AssetFilterSettings;
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
struct AutoComplete;
Cleanup: remove redundant RNA_types.h header from UI_interface.h
2021-01-05 23:04:51 +11:00
struct EnumPropertyItem;
UI: Bring back features for file path button Adds back auto-completion and auto-creation (inserting a non-existing file-path would create it) for the file path button. The second feature was left out knowingly, but seems there are reasonable use cases for it. We can't add these features to the button in the Python script, we have to call into C. So using a template to do that. Note that this is based on the old file browser code, I've copied over the TODO comment.
2019-09-06 01:22:35 +02:00
struct FileSelectParams;
Cleanup: sort forward declarations of enum & struct Done using: source/tools/utils_maintenance/c_sort_blocks.py
2019-01-28 21:08:24 +11:00
struct ID;
struct IDProperty;
struct ImBuf;
struct Image;
struct ImageUser;
struct ListBase;
struct MTex;
UI: * Added a PanelType and HeaderType for registering panels and headers in regions. When the region draws, it will then automatically draw the ones that were registerd with poll and draw callbacks. Used for text header, properties and object buttons now.
2009-03-29 19:44:39 +00:00
struct Panel;
UI: * Template slots are no longer specified per item, but are a state now, set with uiTemplateSlot. * Some renaming of Layout functions for consistency. * Fix for roundbox in stack template, now is always behind the other buttons. * Improved python API for layout: http://www.pasteall.org/5008/python
2009-04-11 01:52:27 +00:00
struct PanelType;
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct PanelCategoryDyn;
struct PanelCategoryStack;
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
struct PointerRNA;
struct PropertyRNA;
2.5: Error reporting * Added a report list to operator, to which they can report errors and warnings. When the operator ends, it will display them with a popup. For python these should become exceptions when calling operators. * Added a function to make a popup menu from a report list. * Also added a utility function to prepend a string before the reports to indicate what they relates to. Also made the report functions used BLI_dynstr to simplify the code. * Made file reading and writing report errors to the user again using this system, also replacing the left over uncommented bad level error() calls.
2008-12-29 13:38:08 +00:00
struct ReportList;
UI: improve menu search with dimmed menu prefix - Show dimmed text for the menu entries leading up to the menu item. - Show icons between the menu text and menu item. - Use unicode right pointing triangle instead of arrow.
2020-04-14 18:46:13 +10:00
struct ResultBLF;
Cleanup: sort forward declarations of enum & struct Done using: source/tools/utils_maintenance/c_sort_blocks.py
2019-01-28 21:08:24 +11:00
struct bContext;
struct bContextStore;
struct bNode;
struct bNodeSocket;
struct bNodeTree;
struct bScreen;
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct MenuType;
Cleanup: pass 'rctf' rectangle to 2D box drawing functions Passing 4x arguments for the rectangle, mixed in with round-box radius & color wasn't very readable. Instead, pass a `rctf` as the first argument to UI box drawing functions.
2021-01-25 18:31:11 +11:00
struct rctf;
2.5 WIP commit for UI drawing. - Hooked up Diego's new Font API - Added Style definitions for fonts, currently it uses a different font for panel titles to show it. - Styles are in Userdef now too, still not finished - Userdef "DPI" will offer global control over font size, to match monitor size/resolution. It's meant to scale widgets and headers too btw, later. - Lots of code removed for old fonts, but that's unfinished. On todo: too much to mention, will continue happily tomorrow!
2009-04-09 18:11:18 +00:00
struct rcti;
UI Code Quality: Use derived structs for search buttons and decorators The current on-size-fits-all `uiBut` creates quite a mess, where it's hard to reason about which members are free for use, under which conditions they are used and how. `uiBut` also has members that aren't used at times, violating the "don't pay for what you don't use" principle. To address this, we want to move to typed buttons, where `uiBut` is just a base struct and each type extends it as needed. That structures data better and type specific data is only available if it's actually used by a button type. Two trade-offs: * Many casts to the derived type have to be done. * Sometimes we change the button type after it's created. So I had to add logic to reallocate the button for use with the new, possibly derived struct. Ideally that wouldn't be needed, but for now that's what we have. Part of T74432. Differential Revision: https://developer.blender.org/D7610 Reviewed by: Brecht Van Lommel, Campbell Barton
2020-08-07 14:34:11 +02:00
struct uiButSearch;
Cleanup: sort forward declarations of enum & struct Done using: source/tools/utils_maintenance/c_sort_blocks.py
2019-01-28 21:08:24 +11:00
struct uiFontStyle;
This commit frees list ui items from their dependencies to Panel, and hence from all the limitations this implied (mostly, the "only one list per panel" one). It introduces a new (py-extendable and registrable) RNA type, UIList (roughly similar to Panel one), which currently contains only "standard" list's scroll pos and size (but may be expended to include e.g. some filtering data, etc.). This now makes lists completely independent from Panels! This UIList has a draw_item callback which allows to customize items' drawing from python, that all addons can now use. Incidentally, this also greatly simplifies the C code of this widget, as we do not code any "special case" here anymore! To make all this work, other changes were also necessary: * Now all buttons (uiBut struct) have a 'custom_data' void pointer, used currently to store the uiList struct associated with a given uiLayoutListBox. * DynamicPaintSurface now exposes a new bool, use_color_preview (readonly), saying whether that surface has some 3D view preview data or not. * UILayout class has now four new (static) functions, to get the actual icon of any RNA object (important e.g. with materials or textures), and to get an enum item's UI name, description and icon. * UILayout's label() func now takes an optional 'icon_value' integer parameter, which if not zero will override the 'icon' one (mandatory to use "custom" icons as generated for material/texture/... previews). Note: not sure whether we should add that one to all UILayout's prop funcs? Note: will update addons using template list asap.
2012-12-28 09:20:16 +00:00
struct uiList;
UI: * Made separator item work horizontal & vertical. * Add colon (:) automatic for int/float/enum/string. * Added space variables to uiStyle and use them in the layout engine. * Added initial World buttons by Thomas Dinges, thanks! * Added some code for modifiers in the Object Data context. This will become a template though. * Use a common poll() callback in the scripts to reduce code.
2009-04-27 18:05:58 +00:00
struct uiStyle;
fix for own missing var in recent commit.
2009-07-03 11:46:46 +00:00
struct uiWidgetColors;
GSOC 2013 paint Yep, at last it's here! There are a few minor issues remaining but development can go on in master after discussion at blender institute. For full list of features see: http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.72/Painting Thanks to Sergey and Campbell for the extensive review and to the countless artists that have given their input and reported issues during development.
2014-07-21 12:02:05 +02:00
struct wmDrag;
Cleanup: sort forward declarations of enum & struct Done using: source/tools/utils_maintenance/c_sort_blocks.py
2019-01-28 21:08:24 +11:00
struct wmDropBox;
struct wmEvent;
WM: rename manipulator to gizmo internally
2018-07-14 23:49:00 +02:00
struct wmGizmo;
Cleanup: sort forward declarations of enum & struct Done using: source/tools/utils_maintenance/c_sort_blocks.py
2019-01-28 21:08:24 +11:00
struct wmKeyConfig;
UI: support for custom keymaps for popovers
2018-05-20 22:34:18 +02:00
struct wmKeyMap;
Icons: support for drawing event icons Use for drawing modal operator header keys.
2018-07-08 11:57:59 +02:00
struct wmKeyMapItem;
Cleanup: sort forward declarations of enum & struct Done using: source/tools/utils_maintenance/c_sort_blocks.py
2019-01-28 21:08:24 +11:00
struct wmMsgBus;
struct wmOperator;
struct wmOperatorType;
UI: Add initial "grid view" Part of T98560. See https://wiki.blender.org/wiki/Source/Interface/Views Adds all the basic functionality needed for grid views. They display items in a grid of rows and columns, typically with a preview image and a label underneath. Think of the main region in the Asset Browser. Current features: - Active item - Notifier listening (also added this to the tree view) - Performance: Skip adding buttons that are not scrolled into view (solves performance problems for big asset libraries, for example). - Custom item size - Preview items (items that draw a preview with a label underneath) - Margins between items scale so the entire region width is filled with column, rather than leaving a big empty block at the right if there's not enough space for another column (like the File and current Asset Browser does it). - "Data-View Item" theme colors. Not shown in the UI yet. No user visible changes expected since the grid views aren't used for anything yet. This was developed as part of a rewrite of the Asset Browser UI (`asset-browser-grid-view` branch), see T95653. There's no reason to keep this part in a branch, continuing development in master makes things easier. Grid and tree views have a lot of very similar code, so I'm planning to unify them to a degree. I kept things separate for the start to first find out how much and what exactly makes sense to override.
2022-06-16 11:29:20 +02:00
struct wmRegionListenerParams;
Cleanup: sort forward declarations of enum & struct Done using: source/tools/utils_maintenance/c_sort_blocks.py
2019-01-28 21:08:24 +11:00
struct wmWindow;
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiBlock;
struct uiBut;
struct uiButExtraOpIcon;
struct uiLayout;
struct uiPopupBlockHandle;
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
struct uiTooltipData;
UI: Add AbstractView base class for views, unify reconstruction in there No user visible changes expected. There's plenty of duplicated code in the grid and the tree view, and I expect this to become more. This starts the process of unifying these parts, which should also make it easier to add new views. Complexity in the view classes is reduced, and some type shenanigans for C compatibility and general view management can be removed, since there is now a common base type. For the start this ports some of the view reconstruction, where the view and its items are compared to the version of itself in the previous redraw, so that state (highlighted, active, renaming, collapsed, ...) can be preserved. Notifier listening is also ported.
2022-07-02 21:49:21 +02:00
/* C handle for C++ #ui::AbstractView type. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiViewHandle;
UI: Port view item features to base class, merge view item button types No user visible changes expected. Merges the tree row and grid tile button types, which were mostly doing the same things. The idea is that there is a button type for highlighting, as well as supporting general view item features (e.g. renaming, drag/drop, etc.). So instead there is a view item button type now. Also ports view item features like renaming, custom context menus, drag controllers and drop controllers to `ui::AbstractViewItem` (the new base class for all view items). This should be quite an improvement because: - Merges code that was duplicated over view items. - Mentioned features (renaming, drag & drop, ...) are much easier to implement in new view types now. Most of it comes "for free". - Further features will immediately become availalbe to all views (e.g. selection). - Simplifies APIs, there don't have to be functions for individual view item types anymore. - View item classes are split and thus less overwhelming visually. - View item buttons now share all code (drawing, handling, etc.) - We're soon running out of available button types, this commit merges two into one. I was hoping I could do this in multiple smaller commits, but things were quite intertwined so that would've taken quite some effort.
2022-07-19 16:14:42 +02:00
/* C handle for C++ #ui::AbstractViewItem type. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiViewItemHandle;
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
/* Defines */
Docs: improve doc-string for UI_BUT_HAS_SEP_CHAR & UI_SEP_CHAR
2023-01-11 13:39:13 +11:00
/**
* Character used for splitting labels (right align text after this character).
* Users should never see this character.
* Only applied when #UI_BUT_HAS_SEP_CHAR flag is enabled, see it's doc-string for details.
*/
interface, replace '|' with define UI_SEP_CHAR
2013-09-11 05:06:27 +00:00
#define UI_SEP_CHAR '|'
#define UI_SEP_CHAR_S "|"
UI: Indeterminate Button State No user visible changes expected, the new button state is not used yet. Setting a new uiBut drawflag shows items in an indeterminate state, not indicating a specific value or state. Pull Request: https://projects.blender.org/blender/blender/pulls/108210
2023-07-17 19:37:15 +02:00
/**
* Character used when value is indeterminate (multiple, unknown, unset).
*/
#define UI_VALUE_INDETERMINATE_CHAR BLI_STR_UTF8_EM_DASH
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/**
* Separator for text in search menus (right pointing arrow).
* keep in sync with `string_search.cc`.
*/
Refactor: UTF-8 Character Defines Use defined UTF-8 Universal character names in place of byte escape sequences and literals. Pull Request: https://projects.blender.org/blender/blender/pulls/109163
2023-06-26 06:05:18 +02:00
#define UI_MENU_ARROW_SEP BLI_STR_UTF8_BLACK_RIGHT_POINTING_SMALL_TRIANGLE
Cleanup: Use common define for menu separator arrow
2021-10-21 12:50:55 -05:00
UI/Nodes: templates to edit nodes from the properties editor using a tree view, to be used by cycles. For testing there's a panel in the node editor if you set debug to 777, didn't enable it because I'm not sure it's very useful there.
2011-11-07 22:28:49 +00:00
/* names */
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
#define UI_MAX_DRAW_STR 400
#define UI_MAX_NAME_STR 128
UI: add ability to access/generate 'shortcuts strings' of modal keymaps. We already had that for global keymaps (used e.g. to generate shortcuts for menu entries), but this wasn’t possible for modal keymaps yet (e.g. help message in header during transforms and other modal operation). This commit only adds needing background code, it does not change anything from user PoV. Modal operators will be updated to use it in comming weeks. Thanks to Campbell for revisions & suggestions. :) Differential Revision: https://developer.blender.org/D780
2015-07-03 15:07:46 +02:00
#define UI_MAX_SHORTCUT_STR 64
UI/Nodes: templates to edit nodes from the properties editor using a tree view, to be used by cycles. For testing there's a panel in the node editor if you set debug to 777, didn't enable it because I'm not sure it's very useful there.
2011-11-07 22:28:49 +00:00
UI: ignore events in empty region overlap areas - Resizable areas use 2D view bounds. - Header uses the button bounds. - A margin is added to avoid clicking between buttons. - Region resize edges clamp to the 2D view bounds. Resovles T61554
2019-04-23 16:43:50 +10:00
/**
* For #ARegion.overlap regions, pass events though if they don't overlap
* the regions contents (the usable part of the #View2D and buttons).
*
Cleanup: spelling
2019-08-31 01:19:22 +10:00
* The margin is needed so it's not possible to accidentally click in between buttons.
UI: ignore events in empty region overlap areas - Resizable areas use 2D view bounds. - Header uses the button bounds. - A margin is added to avoid clicking between buttons. - Region resize edges clamp to the 2D view bounds. Resovles T61554
2019-04-23 16:43:50 +10:00
*/
#define UI_REGION_OVERLAP_MARGIN (U.widget_unit / 3)
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Use for clamping popups within the screen. */
fix for annoyance where header menus would get scroller arrows added because it would be clamped within the screen a few pixels. This was caused from using theme shadow setting to clip the popups and a hard-coded value to translate the popup within screen bounds - these values should be the same.
2013-02-07 02:03:31 +00:00
#define UI_SCREEN_MARGIN 10
Cleanup: rename uiBut.dt, uiBlock.dt to 'emboss' Use 'emboss' instead of 'draw_type' as enum, layout & functions use the term emboss. This issue was noted by @Poulpator in D8414, as `dt` is also an abbreviation for delta-time.
2020-07-29 12:05:27 +10:00
/** #uiBlock.emboss and #uiBut.emboss */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
enum eUIEmbossType {
Cleanup: use doxygen doc-strings, spelling in comments
2023-10-12 09:22:34 +11:00
/** Use widget style for drawing. */
UI_EMBOSS = 0,
/** Nothing, only icon and/or text */
UI_EMBOSS_NONE = 1,
/** Pull-down menu style */
UI_EMBOSS_PULLDOWN = 2,
/** Pie Menu */
UI_EMBOSS_RADIAL = 3,
Fix T83868: Button animation states no longer visible without emboss This bug was caused by making it so that non-embossed modifier icon buttons could become an operator button and retain their red highlight for disabled modifiers. The icon button needs emboss turned off, but in earlier versions of Blender, `UI_EMBOSS_NONE` would be overridden by animation or red alert states. Instead of abusing "NONE" to mean "none unless there is animation or red alert", this commit adds a new emboss flag for that situation, `UI_EMBOSS_NONE_OR_STATUS`, which uses no emboss unless there is an animation state, or another status. There are only a few situations where this is necessary, so the change isn't too big. Differential Revision: https://developer.blender.org/D9902
2020-12-18 17:13:15 -06:00
/**
Cleanup: typos (repeated words)
2021-01-05 13:38:48 +11:00
* The same as #UI_EMBOSS_NONE, unless the button has
Fix T83868: Button animation states no longer visible without emboss This bug was caused by making it so that non-embossed modifier icon buttons could become an operator button and retain their red highlight for disabled modifiers. The icon button needs emboss turned off, but in earlier versions of Blender, `UI_EMBOSS_NONE` would be overridden by animation or red alert states. Instead of abusing "NONE" to mean "none unless there is animation or red alert", this commit adds a new emboss flag for that situation, `UI_EMBOSS_NONE_OR_STATUS`, which uses no emboss unless there is an animation state, or another status. There are only a few situations where this is necessary, so the change isn't too big. Differential Revision: https://developer.blender.org/D9902
2020-12-18 17:13:15 -06:00
* a coloring status like an animation state or red alert.
*/
UI_EMBOSS_NONE_OR_STATUS = 4,
Cleanup: use doxygen doc-strings, spelling in comments
2023-10-12 09:22:34 +11:00
/** For layout engine, use emboss from block. */
UI_EMBOSS_UNDEFINED = 255,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** #uiBlock::direction */
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
enum {
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_DIR_UP = 1 << 0,
UI_DIR_DOWN = 1 << 1,
UI_DIR_LEFT = 1 << 2,
UI_DIR_RIGHT = 1 << 3,
UI_DIR_CENTER_X = 1 << 4,
UI_DIR_CENTER_Y = 1 << 5,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_DIR_ALL = UI_DIR_UP | UI_DIR_DOWN | UI_DIR_LEFT | UI_DIR_RIGHT,
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
};
Use bit-shift op for all bit-flags. Btw, there is a comment stating that bits 12-15 are the same for uiBlock->flag and uiBut->flag, this is obviously no more true currently (maybe it is now bits 14-17, i.e. ALIGN flags?).
2013-06-25 10:30:07 +00:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** #uiBlock.flag (controls) */
enum {
UI_BLOCK_LOOP = 1 << 0,
UI: Consistent Menu/Block/Popup Content Ordering All Content is shown in natural top-down order regardless of where it is initiated. Pull Request: https://projects.blender.org/blender/blender/pulls/109798
2023-08-31 20:24:53 +02:00
UI_BLOCK_NUMSELECT = 1 << 1,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** Don't apply window clipping. */
UI: Consistent Menu/Block/Popup Content Ordering All Content is shown in natural top-down order regardless of where it is initiated. Pull Request: https://projects.blender.org/blender/blender/pulls/109798
2023-08-31 20:24:53 +02:00
UI_BLOCK_NO_WIN_CLIP = 1 << 2,
UI_BLOCK_CLIPBOTTOM = 1 << 3,
UI_BLOCK_CLIPTOP = 1 << 4,
UI_BLOCK_MOVEMOUSE_QUIT = 1 << 5,
UI_BLOCK_KEEP_OPEN = 1 << 6,
UI_BLOCK_POPUP = 1 << 7,
UI_BLOCK_OUT_1 = 1 << 8,
UI_BLOCK_SEARCH_MENU = 1 << 9,
UI_BLOCK_POPUP_MEMORY = 1 << 10,
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Stop handling mouse events. */
UI: Consistent Menu/Block/Popup Content Ordering All Content is shown in natural top-down order regardless of where it is initiated. Pull Request: https://projects.blender.org/blender/blender/pulls/109798
2023-08-31 20:24:53 +02:00
UI_BLOCK_CLIP_EVENTS = 1 << 11,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/* #uiBlock::flags bits 14-17 are identical to #uiBut::drawflag bits. */
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BLOCK_POPUP_HOLD = 1 << 18,
UI_BLOCK_LIST_ITEM = 1 << 19,
UI_BLOCK_RADIAL = 1 << 20,
UI_BLOCK_POPOVER = 1 << 21,
UI_BLOCK_POPOVER_ONCE = 1 << 22,
Cleanup: spelling
2020-09-16 15:28:02 +10:00
/** Always show key-maps, even for non-menus. */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BLOCK_SHOW_SHORTCUT_ALWAYS = 1 << 23,
Outliner: Don't draw library overrides indicator for override buttons All the buttons in the Library Overrides display mode would be shown in cyan, indicating that they are library overrides. Given that this is solely what this display mode is about, the indicator is just redundant, confusing (why are the buttons purple?) and looks weird. Part of T95802. Reviewed by: Bastien Montagne Differential Revision: https://developer.blender.org/D14416
2022-03-24 17:40:59 +01:00
/** Don't show library override state for buttons in this block. */
UI_BLOCK_NO_DRAW_OVERRIDDEN_STATE = 1 << 24,
UI: Single tab property search This adds a search bar to the properties editor. The full search for every tab isn't included in this patch, but the interaction with panels, searching behavior, UI, region level, and DNA changes are included here. The block-level search works by iterating over the block's button groups and checking whether they match the search. If they do, they are tagged with a flag, and the block's panel is tagged too. For every update (text edit), the panel's expansion is set to whether the panel has a result or not. The search also checks for matching strings inside enums and in panel labels. One complication to this that isn't immediately apparent is that closed panel's subpanels have to be searched too. This adds some complexity to the area-level panel layout code. Possible Future Improvements: - Use the new fuzzy search in BLI - Reset panels to their expansion before the search started if the user escape out of the text box. - Open all child panels of a panel with expansion. Differential Revision: https://developer.blender.org/D8856
2020-09-15 11:25:49 -05:00
/** The block is only used during the search process and will not be drawn.
Cleanup: spelling
2020-09-16 15:28:02 +10:00
* Currently just for the case of a closed panel's sub-panel (and its sub-panels). */
UI: Single tab property search This adds a search bar to the properties editor. The full search for every tab isn't included in this patch, but the interaction with panels, searching behavior, UI, region level, and DNA changes are included here. The block-level search works by iterating over the block's button groups and checking whether they match the search. If they do, they are tagged with a flag, and the block's panel is tagged too. For every update (text edit), the panel's expansion is set to whether the panel has a result or not. The search also checks for matching strings inside enums and in panel labels. One complication to this that isn't immediately apparent is that closed panel's subpanels have to be searched too. This adds some complexity to the area-level panel layout code. Possible Future Improvements: - Use the new fuzzy search in BLI - Reset panels to their expansion before the search started if the user escape out of the text box. - Open all child panels of a panel with expansion. Differential Revision: https://developer.blender.org/D8856
2020-09-15 11:25:49 -05:00
UI_BLOCK_SEARCH_ONLY = 1 << 25,
UI: Correct the text alignment in the quick setup (splash screen) dialog The "quick setup" dialog is actually a 'menu', and the "splash screen" block contains the UI_BLOCK_LOOP flag which causes the buttons' text to align to the left, however, usually regular buttons have centered text. As a workaround, add the UI_BLOCK_QUICK_SETUP flag which prevents the text from being left-aligned. Differential Revision: https://developer.blender.org/D10486 Reviewed by: Julian Eisel
2021-02-21 17:26:55 +01:00
/** Hack for quick setup (splash screen) to draw text centered. */
UI_BLOCK_QUICK_SETUP = 1 << 26,
UI: support searching in menus The basic idea is very simple. Whenever a supported menu is open, one can just start typing and this opens a search that contains all the (nested) menu entries. The main downside is that this collides with accelerator keys. Those are the underlined characters in each menu. For now, we just enable this new searching behavior in a few selected menus: Node Add Menu, View3D Add Menu and Modifier Add Menu. This new functionality can be enabled for a menu by setting `bl_options = {'SEARCH_ON_KEY_PRESS'}` to true in the menu type. The status bar shows `Type to search...` when a menu is opened that supports search. Pull Request: https://projects.blender.org/blender/blender/pulls/110855
2023-09-06 18:16:45 +02:00
/** Don't accelerator keys for the items in the block. */
UI_BLOCK_NO_ACCELERATOR_KEYS = 1 << 27,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
};
/** #uiPopupBlockHandle.menuretval */
enum {
/** Cancel all menus cascading. */
UI_RETURN_CANCEL = 1 << 0,
/** Choice made. */
UI_RETURN_OK = 1 << 1,
/** Left the menu. */
UI_RETURN_OUT = 1 << 2,
/** Let the parent handle this event. */
UI_RETURN_OUT_PARENT = 1 << 3,
/** Update the button that opened. */
UI_RETURN_UPDATE = 1 << 4,
/** Popup is ok to be handled. */
UI_RETURN_POPUP_OK = 1 << 5,
};
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: uiBut.flag had an internal flag out of the documented range Increase range of internal flags & order UI_SEARCH_FILTER_NO_MATCH within this range, so public button flags aren't accidentally added that overlap with internal flags.
2021-04-20 15:44:21 +10:00
/** #uiBut.flag general state flags. */
Squashed commit of the following: commit 6f97e194e58aab38d351c796bf7bb6abca33f5f9 Author: Bastien Montagne <montagne29@wanadoo.fr> Date: Wed Nov 20 21:18:20 2013 +0100 Code cleanup: Move some uiBut->flag to uiBut->drawflag, make those flags anonymous enums. Summary: Make some room in but->flag (I did not add another flag, we already have drawflag, which was nearly not used up till now). Note: I’m not sure whether REDALERT (and perhaps even DISABLED?) should not go to but->drawflag as well... Related to D8 Reviewers: brecht Differential Revision: http://developer.blender.org/D22
2013-11-21 14:43:08 +01:00
enum {
Fix T97518: All buttons with eyedropper highlight if one is hovered Issue is that the operator acts on the active button, and also uses that in the poll. So the actually active button would affect the poll of a different button. For the superimposed icons we need to be able to execute these polls properly for non-active buttons. This enables temporarily overriding the active button for lookups via context. While a bit of a hack it makes sense conceptually. Reviewed By: Campbell Barton Maniphest Tasks: T97518 Differential Revision: https://developer.blender.org/D14880
2022-05-13 15:55:11 +02:00
/* WARNING: the first 8 flags are internal (see #UI_SELECT definition). */
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
Fix T97518: All buttons with eyedropper highlight if one is hovered Issue is that the operator acts on the active button, and also uses that in the poll. So the actually active button would affect the poll of a different button. For the superimposed icons we need to be able to execute these polls properly for non-active buttons. This enables temporarily overriding the active button for lookups via context. While a bit of a hack it makes sense conceptually. Reviewed By: Campbell Barton Maniphest Tasks: T97518 Differential Revision: https://developer.blender.org/D14880
2022-05-13 15:55:11 +02:00
UI_BUT_ICON_SUBMENU = 1 << 8,
UI_BUT_ICON_PREVIEW = 1 << 9,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Fix T97518: All buttons with eyedropper highlight if one is hovered Issue is that the operator acts on the active button, and also uses that in the poll. So the actually active button would affect the poll of a different button. For the superimposed icons we need to be able to execute these polls properly for non-active buttons. This enables temporarily overriding the active button for lookups via context. While a bit of a hack it makes sense conceptually. Reviewed By: Campbell Barton Maniphest Tasks: T97518 Differential Revision: https://developer.blender.org/D14880
2022-05-13 15:55:11 +02:00
UI_BUT_NODE_LINK = 1 << 10,
UI_BUT_NODE_ACTIVE = 1 << 11,
UI_BUT_DRAG_LOCK = 1 << 12,
Cleanup: spelling
2019-04-10 08:40:49 +02:00
/** Grayed out and un-editable. */
Fix T97518: All buttons with eyedropper highlight if one is hovered Issue is that the operator acts on the active button, and also uses that in the poll. So the actually active button would affect the poll of a different button. For the superimposed icons we need to be able to execute these polls properly for non-active buttons. This enables temporarily overriding the active button for lookups via context. While a bit of a hack it makes sense conceptually. Reviewed By: Campbell Barton Maniphest Tasks: T97518 Differential Revision: https://developer.blender.org/D14880
2022-05-13 15:55:11 +02:00
UI_BUT_DISABLED = 1 << 13,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Fix T97518: All buttons with eyedropper highlight if one is hovered Issue is that the operator acts on the active button, and also uses that in the poll. So the actually active button would affect the poll of a different button. For the superimposed icons we need to be able to execute these polls properly for non-active buttons. This enables temporarily overriding the active button for lookups via context. While a bit of a hack it makes sense conceptually. Reviewed By: Campbell Barton Maniphest Tasks: T97518 Differential Revision: https://developer.blender.org/D14880
2022-05-13 15:55:11 +02:00
UI_BUT_ANIMATED = 1 << 14,
UI_BUT_ANIMATED_KEY = 1 << 15,
UI_BUT_DRIVEN = 1 << 16,
UI_BUT_REDALERT = 1 << 17,
Cleanup: spelling
2019-04-10 08:40:49 +02:00
/** Grayed out but still editable. */
Fix T97518: All buttons with eyedropper highlight if one is hovered Issue is that the operator acts on the active button, and also uses that in the poll. So the actually active button would affect the poll of a different button. For the superimposed icons we need to be able to execute these polls properly for non-active buttons. This enables temporarily overriding the active button for lookups via context. While a bit of a hack it makes sense conceptually. Reviewed By: Campbell Barton Maniphest Tasks: T97518 Differential Revision: https://developer.blender.org/D14880
2022-05-13 15:55:11 +02:00
UI_BUT_INACTIVE = 1 << 18,
UI_BUT_LAST_ACTIVE = 1 << 19,
UI_BUT_UNDO = 1 << 20,
UI: Get rid of redundant UI_BUT_IMMEDIATE button flag This flag was used to activate the hotkey input buttons (e.g. for "Assign Shortcut") when opened in a popup. Since this was added, other more generalized ways of getting this same behavior were implemented. Had to tweak the hotkey button event handling a bit, but it seems to behave exactly as before now.
2022-05-20 16:27:08 +02:00
/* UNUSED = 1 << 21, */
Fix T97518: All buttons with eyedropper highlight if one is hovered Issue is that the operator acts on the active button, and also uses that in the poll. So the actually active button would affect the poll of a different button. For the superimposed icons we need to be able to execute these polls properly for non-active buttons. This enables temporarily overriding the active button for lookups via context. While a bit of a hack it makes sense conceptually. Reviewed By: Campbell Barton Maniphest Tasks: T97518 Differential Revision: https://developer.blender.org/D14880
2022-05-13 15:55:11 +02:00
UI_BUT_NO_UTF8 = 1 << 22,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
UI: minor change to active-default logic Don't attempt to activate default button if it's already active. Also expand on the flags comment.
2019-03-28 00:57:46 +11:00
/** For popups, pressing return activates this button, overriding the highlighted button.
* For non-popups this is just used as a display hint for the user to let them
* know the action which is activated when pressing return (file selector for eg). */
Revert commits to increase button flag bitfield size This reverts the commits 8d9d5da13706b668b9bd0d631e00c9b00b73f3ea, 59cd616534b46ab85b4324a0886bd9eb8876a48b and 98a04ed4524234b1840dc039c2f356db5ac57f26. The commits are causing issues with MSVC, see D14926. I'm working on a different solution, but that will need some work.
2022-05-12 15:53:12 +02:00
UI_BUT_ACTIVE_DEFAULT = 1 << 23,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** This but is "inside" a list item (currently used to change theme colors). */
Revert commits to increase button flag bitfield size This reverts the commits 8d9d5da13706b668b9bd0d631e00c9b00b73f3ea, 59cd616534b46ab85b4324a0886bd9eb8876a48b and 98a04ed4524234b1840dc039c2f356db5ac57f26. The commits are causing issues with MSVC, see D14926. I'm working on a different solution, but that will need some work.
2022-05-12 15:53:12 +02:00
UI_BUT_LIST_ITEM = 1 << 24,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** edit this button as well as the active button (not just dragging) */
Revert commits to increase button flag bitfield size This reverts the commits 8d9d5da13706b668b9bd0d631e00c9b00b73f3ea, 59cd616534b46ab85b4324a0886bd9eb8876a48b and 98a04ed4524234b1840dc039c2f356db5ac57f26. The commits are causing issues with MSVC, see D14926. I'm working on a different solution, but that will need some work.
2022-05-12 15:53:12 +02:00
UI_BUT_DRAG_MULTI = 1 << 25,
UI: support for popups starting with buttons activated While this could already be done from C, this is now exposed to Python
2019-03-20 22:40:38 +11:00
/** Use for popups to start editing the button on initialization. */
Revert commits to increase button flag bitfield size This reverts the commits 8d9d5da13706b668b9bd0d631e00c9b00b73f3ea, 59cd616534b46ab85b4324a0886bd9eb8876a48b and 98a04ed4524234b1840dc039c2f356db5ac57f26. The commits are causing issues with MSVC, see D14926. I'm working on a different solution, but that will need some work.
2022-05-12 15:53:12 +02:00
UI_BUT_ACTIVATE_ON_INIT = 1 << 26,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Docs: improve doc-string for UI_BUT_HAS_SEP_CHAR & UI_SEP_CHAR
2023-01-11 13:39:13 +11:00
/**
* #uiBut.str contains #UI_SEP_CHAR, used to show key-shortcuts right aligned.
*
* Since a label may contain #UI_SEP_CHAR, it's important to split on the last occurrence
* (meaning the right aligned text can't contain this character).
*/
Revert commits to increase button flag bitfield size This reverts the commits 8d9d5da13706b668b9bd0d631e00c9b00b73f3ea, 59cd616534b46ab85b4324a0886bd9eb8876a48b and 98a04ed4524234b1840dc039c2f356db5ac57f26. The commits are causing issues with MSVC, see D14926. I'm working on a different solution, but that will need some work.
2022-05-12 15:53:12 +02:00
UI_BUT_HAS_SEP_CHAR = 1 << 27,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** Don't run updates while dragging (needed in rare cases). */
Revert commits to increase button flag bitfield size This reverts the commits 8d9d5da13706b668b9bd0d631e00c9b00b73f3ea, 59cd616534b46ab85b4324a0886bd9eb8876a48b and 98a04ed4524234b1840dc039c2f356db5ac57f26. The commits are causing issues with MSVC, see D14926. I'm working on a different solution, but that will need some work.
2022-05-12 15:53:12 +02:00
UI_BUT_UPDATE_DELAY = 1 << 28,
Cleanup: spelling in comments
2022-05-05 10:55:51 +10:00
/** When widget is in text-edit mode, update value on each char stroke. */
Revert commits to increase button flag bitfield size This reverts the commits 8d9d5da13706b668b9bd0d631e00c9b00b73f3ea, 59cd616534b46ab85b4324a0886bd9eb8876a48b and 98a04ed4524234b1840dc039c2f356db5ac57f26. The commits are causing issues with MSVC, see D14926. I'm working on a different solution, but that will need some work.
2022-05-12 15:53:12 +02:00
UI_BUT_TEXTEDIT_UPDATE = 1 << 29,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** Show 'x' icon to clear/unlink value of text or search button. */
Revert commits to increase button flag bitfield size This reverts the commits 8d9d5da13706b668b9bd0d631e00c9b00b73f3ea, 59cd616534b46ab85b4324a0886bd9eb8876a48b and 98a04ed4524234b1840dc039c2f356db5ac57f26. The commits are causing issues with MSVC, see D14926. I'm working on a different solution, but that will need some work.
2022-05-12 15:53:12 +02:00
UI_BUT_VALUE_CLEAR = 1 << 30,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** RNA property of the button is overridden from linked reference data. */
Revert commits to increase button flag bitfield size This reverts the commits 8d9d5da13706b668b9bd0d631e00c9b00b73f3ea, 59cd616534b46ab85b4324a0886bd9eb8876a48b and 98a04ed4524234b1840dc039c2f356db5ac57f26. The commits are causing issues with MSVC, see D14926. I'm working on a different solution, but that will need some work.
2022-05-12 15:53:12 +02:00
UI_BUT_OVERRIDDEN = 1u << 31u,
Squashed commit of the following: commit 6f97e194e58aab38d351c796bf7bb6abca33f5f9 Author: Bastien Montagne <montagne29@wanadoo.fr> Date: Wed Nov 20 21:18:20 2013 +0100 Code cleanup: Move some uiBut->flag to uiBut->drawflag, make those flags anonymous enums. Summary: Make some room in but->flag (I did not add another flag, we already have drawflag, which was nearly not used up till now). Note: I’m not sure whether REDALERT (and perhaps even DISABLED?) should not go to but->drawflag as well... Related to D8 Reviewers: brecht Differential Revision: http://developer.blender.org/D22
2013-11-21 14:43:08 +01:00
};
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
UI: support searching in menus The basic idea is very simple. Whenever a supported menu is open, one can just start typing and this opens a search that contains all the (nested) menu entries. The main downside is that this collides with accelerator keys. Those are the underlined characters in each menu. For now, we just enable this new searching behavior in a few selected menus: Node Add Menu, View3D Add Menu and Modifier Add Menu. This new functionality can be enabled for a menu by setting `bl_options = {'SEARCH_ON_KEY_PRESS'}` to true in the menu type. The status bar shows `Type to search...` when a menu is opened that supports search. Pull Request: https://projects.blender.org/blender/blender/pulls/110855
2023-09-06 18:16:45 +02:00
enum {
/**
* This is used when `UI_BUT_ACTIVATE_ON_INIT` is used, which is used to activate e.g. a search
* box as soon as a popup opens. Usually, the text in the search box is selected by default.
* However, sometimes this behavior is not desired, so it can be disabled with this flag.
*/
UI_BUT2_ACTIVATE_ON_INIT_NO_SELECT = 1 << 0,
};
Revert release branch only commit after merge This is a revert of a revert, because the initial revert is only supposed to be in the release branch. This reverts commit 3eed00dc546b5930b255572901915ccbc26c0e69.
2023-02-20 11:51:16 +01:00
/** #uiBut.dragflag */
enum {
/** By default only the left part of a button triggers dragging. A questionable design to make
* the icon but not other parts of the button draggable. Set this flag so the entire button can
* be dragged. */
UI_BUT_DRAG_FULL_BUT = (1 << 0),
/* --- Internal flags. --- */
UI_BUT_DRAGPOIN_FREE = (1 << 1),
};
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Default font size for normal text. */
BLF: Use Floats for Font Point Sizes Allow the use of floating-point values for font point sizes, which allows greater precision and flexibility for text output. See D8960 for more information, details, and justification. Differential Revision: https://developer.blender.org/D8960 Reviewed by Campbell Barton
2021-11-13 09:39:18 -08:00
#define UI_DEFAULT_TEXT_POINTS 11.0f
UI: Remove Hard-coded Default Font Size Default text output routines (which do not specify a size) will now use Text Style point size. Differential Revision: https://developer.blender.org/D9107 Reviewed by Brecht Van Lommel
2020-10-12 09:53:00 -07:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Larger size used for title text. */
BLF: Use Floats for Font Point Sizes Allow the use of floating-point values for font point sizes, which allows greater precision and flexibility for text output. See D8960 for more information, details, and justification. Differential Revision: https://developer.blender.org/D8960 Reviewed by Campbell Barton
2021-11-13 09:39:18 -08:00
#define UI_DEFAULT_TITLE_POINTS 11.0f
UI: Remove Hard-coded Default Font Size Default text output routines (which do not specify a size) will now use Text Style point size. Differential Revision: https://developer.blender.org/D9107 Reviewed by Brecht Van Lommel
2020-10-12 09:53:00 -07:00
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
#define UI_PANEL_WIDTH 340
#define UI_COMPACT_PANEL_WIDTH 160
UI: make sidebars in 3D view and other editors a little wider and consistent
2019-05-15 16:17:23 +02:00
#define UI_SIDEBAR_PANEL_WIDTH 220
UI: Initial User-Preferences redesign Implements the first changes for T54115: * Rename "User Preferences" window to "Settings" in the UI. We'll likely put workspace settings in there, separate from the global user settings. System settings should become separate from user settings in future to allow settings for specific hardware. * Add sidebar region for navigation (scrolls independently). Addresses space problems, so we can add more categories as needed now. * Increase size of Settings window to compensate new navigation bar. * Group sections into User Preferences and System. Icons for section groups by Andrzej Ambroz. Thanks! * Bumps subversion for file compatibility. Screenshot: https://developer.blender.org/F5715337 I also added categories for future work, but commented them out. We may also want to redesign contents of each section now. Reviewers: brecht, campbellbarton Differential Revision: https://developer.blender.org/D3088 Design Task: https://developer.blender.org/T54115
2018-11-25 16:21:35 +01:00
#define UI_NAVIGATION_REGION_WIDTH UI_COMPACT_PANEL_WIDTH
Preferences: fit a little better when opened in place of properties editor.
2019-01-17 14:31:18 +01:00
#define UI_NARROW_NAVIGATION_REGION_WIDTH 100
2.5 WIP commit for UI drawing. - Hooked up Diego's new Font API - Added Style definitions for fonts, currently it uses a different font for panel titles to show it. - Styles are in Userdef now too, still not finished - Userdef "DPI" will offer global control over font size, to match monitor size/resolution. It's meant to scale widgets and headers too btw, later. - Lots of code removed for old fonts, but that's unfinished. On todo: too much to mention, will continue happily tomorrow!
2009-04-09 18:11:18 +00:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** The width of one icon column of the Toolbar. */
UI: Correct default width of toolbars Correct default initial widths of toolbars Pull Request: https://projects.blender.org/blender/blender/pulls/108292
2023-06-08 18:27:59 +02:00
#define UI_TOOLBAR_COLUMN (1.25f * ICON_DEFAULT_HEIGHT_TOOLBAR)
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** The space between the Toolbar and the area's edge. */
UI: Correct default width of toolbars Correct default initial widths of toolbars Pull Request: https://projects.blender.org/blender/blender/pulls/108292
2023-06-08 18:27:59 +02:00
#define UI_TOOLBAR_MARGIN (0.5f * ICON_DEFAULT_HEIGHT_TOOLBAR)
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Total width of Toolbar showing one icon column. */
UI: Correct default width of toolbars Correct default initial widths of toolbars Pull Request: https://projects.blender.org/blender/blender/pulls/108292
2023-06-08 18:27:59 +02:00
#define UI_TOOLBAR_WIDTH UI_TOOLBAR_MARGIN + UI_TOOLBAR_COLUMN
Make Toolbar Tabs more readable This makes the tabs slightly larger, increases the text size slightly, and adjusts the colors a bit to improve overall contrast. It also makes inactive tabs draw with a full tab shape, improving the readability at a glance, particularly when tabs are very small. The users most affected will be those on smaller displays, where previously tabs were very difficult to read. Reviewers: @billrey, @campbellbarton Differential Revision: https://developer.blender.org/D170
2014-01-04 13:54:39 -06:00
#define UI_PANEL_CATEGORY_MARGIN_WIDTH (U.widget_unit * 1.0f)
UI: Tabs categories for panels (D75) - works by defining panel categories, currently restricted to the toolbar. - no panels define bl_categories yet, so no user visible changes since tabs only show when there are multiple. - panel pinning is available in rmb menu or alt+lmb.
2013-12-17 03:21:55 +11:00
Fix T92313: Heading of redo panel is not aligned properly This corrects some alignments issues through new margins introduced in 93544b641bd6. Basic idea of this fix is to only add the new margins when drawing a panel with background. These margins were added specifically for the background boxes, so that makes sense. Alternative fix to D13199. This also fixes some margings added unintentionally in mentioned commit. There is a little jump of the toolbar and the tabs in the Properties when comparing the UI without this fix to 2.93: {F12158085} {F12158039} The jump is gone with this fix applied (compare to the 2.93 screenshot): {F12158064} While not a serious issue, this confirms that this fix actually tackles the root of the issue.
2021-11-25 16:53:44 +01:00
/* Both these margins should be ignored if the panel doesn't show a background (check
* #UI_panel_should_show_background()). */
UI: Visual style update to panels Back in Blender 2.30, the GUI project brought panels into Blender among other important visual updates. For the first time it was possible to move the wall of buttons around. Providing a clear separation between sections (it even allowed the grouping of panels in tabs!) During the 2.5 redesign, the separation between panels became a line on top of each panel, and panels received theme settings for background and header colors. The default theme used the same color for both. In 2.8 the background color of panels was different from headers in the default theme, so the separator line was removed. While the separator line wasn't elegant (only on top, non-themeable, hard-coded emboss effect), it provided a sort of separation between panels. This patch solves the panels-separation by simply adding a margin space around them (not visible in default theme yet). Even though the margin reduces the width of the working area slightly, it makes room for the upcoming always-visible scrollbars. Other adjustments: * Use arrow icon instead of triangle to collapse/expand * Use rounded corners to match the rest of the UI (editor corners, nodes, etc). {F10953929, size=full} Margin on panels makes use of the `style->panelouter` property that hasn't been used in a while. Also slight tweaks to `boxspace` and `templatespace` style properties so they are multiples of 2 and operations on them round better. There is technically no need to update the themes for them to work, so no theme changes are included in this patch. {F10953931, size=full} {F10953933, size=full} {F10953934, size=full} {F10954003, size=full} ---- A new theme setting under Style controls the roundness of all panels (added it to Style instead of ThemeSpace because I think controlling the panel roundness per editor is a bit overkill): {F11091561, size=full, autoplay, loop} Reviewed By: HooglyBoogly Differential Revision: https://developer.blender.org/D12814
2021-10-17 18:22:53 +02:00
#define UI_PANEL_MARGIN_X (U.widget_unit * 0.4f)
UI: Reduce vertical margin between panels In an attempt to reduce scrolling. This can be re-visited if a kind of switch between "compact" and "comfortable" UI size is implemented in the future.
2021-10-18 16:16:34 +02:00
#define UI_PANEL_MARGIN_Y (U.widget_unit * 0.1f)
UI: List Panel System This implements a general system to implement drag and drop, subpanels, and UI animation for the stack UIs in Blender. There are NO functional changes in this patch, but it makes it relatively trivial to implement these features for stacks. The biggest complication to using panels to implement the UI for lists is that there can be multiple modifiers of the same type. Currently there is an assumed 1 to 1 relationship between every panel and its type, but there can be multiple list items of the same type, so we have to break this relationship. The mapping between panels and their data is stored with an index in the panel's runtime struct. To make use the system for a list like modifiers, four components must be added: 1. A panel type defined and registered for each list data type, with a known mapping between list data types and panel idnames. 1. A function called by interface code to build the add the panel layouts with the provided helper functions. - UI_panel_list_matches_data will check if the panel list needs to be rebuilt. - UI_panels_free_instanced will remove the existing list panels - UI_panel_add_instanced adds a list panel of a given type. 3. An expand flag for the list data and implementations of get_list_data_expand_flag and set_list_data_expand_flag. 4. For reordering, the panel type's reorder callback. This is called when the instanced panels are drag-dropped. This requires implementing a "move to index" operator for the list data. Reviewed By: Severin, brecht Differential Revision: https://developer.blender.org/D7490
2020-05-26 15:39:49 -04:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/**
* #uiBut::drawflag, these flags should only affect how the button is drawn.
*
* \note currently, these flags *are not passed* to the widgets state() or draw() functions
* (except for the 'align' ones)!
Squashed commit of the following: commit b8b7180760b7c57f15b9930c29207febcf5fefb3 Author: Bastien Montagne <montagne29@wanadoo.fr> Date: Thu Nov 21 16:31:16 2013 +0100 Code cleanup: replace "LISTLABEL" button type by an "UI_BUT_LIST_ITEM" button flag. Summary: Rationals: I) I was never that happy to have a full button type just to set custom colors to labels inside listitems! II) If we use (as planned) TEX buttons instead of labels to allow listitems click-rename, I'd like to be able to use listitems' theme color here as well, much easier witha flag than adding yet another button type! Note: related to D8 Reviewers: brecht Differential Revision: http://developer.blender.org/D25
2013-11-21 16:51:29 +01:00
*/
Squashed commit of the following: commit 6f97e194e58aab38d351c796bf7bb6abca33f5f9 Author: Bastien Montagne <montagne29@wanadoo.fr> Date: Wed Nov 20 21:18:20 2013 +0100 Code cleanup: Move some uiBut->flag to uiBut->drawflag, make those flags anonymous enums. Summary: Make some room in but->flag (I did not add another flag, we already have drawflag, which was nearly not used up till now). Note: I’m not sure whether REDALERT (and perhaps even DISABLED?) should not go to but->drawflag as well... Related to D8 Reviewers: brecht Differential Revision: http://developer.blender.org/D22
2013-11-21 14:43:08 +01:00
enum {
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** Text and icon alignment (by default, they are centered). */
UI_BUT_TEXT_LEFT = 1 << 1,
UI_BUT_ICON_LEFT = 1 << 2,
UI_BUT_TEXT_RIGHT = 1 << 3,
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Prevent the button to show any tool-tip. */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BUT_NO_TOOLTIP = 1 << 4,
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/**
* Show a quick tool-tip label, that is, a short tool-tip that appears faster than the full one
* and only shows the label. After a short delay the full tool-tip is shown if any.
*/
UI: Refactor quick label tooltip implementation for buttons No user visible changes expected. Used in the asset shelf branch, see #104831. These tooltips only show a label string and appear after a shorter timeout than the regular tooltips. After the regular tooltip timeout they expand to the full tooltip. The toolbar and properties editor navigation tabs make use of this already. The changes here enable more control over quick label tooltips, making them usable in more cases, and less ad-hoc. Main changes: - Refactors internal logic so a single `UI_BUT_HAS_TOOLTIP_LABEL` button flag can be used to enable quick label tooltips. This decentralizes logic in a way that's more consistent and extensible. - Custom callback to return a quick label. This is useful when a label tooltip should be displayed even when there is no button string set. E.g. in the asset shelf with "Show Names" disabled. Pull Request: https://projects.blender.org/blender/blender/pulls/110200
2023-07-25 16:22:31 +02:00
UI_BUT_HAS_TOOLTIP_LABEL = 1 << 5,
UI: Better split layout support for checkboxes Makes the following layout changes possible: {F8473498} {F8473499} {F8473502} The next commit will contain many layout changes to make good use of these new possibilities. The result should be more consistent, easier to read and should give a more organized impression. Additionally, it should be possible to replace many sub-panels with compacter layouts. Main changes: * Checkboxes now respect the property split layouts * Add support for row and column headers (i.e. `uiLayout.column(heading="Foo")`, `uiLayout.row(heading="Bar")`). If the first property added to this layout doesn't insert anything into the label split column, the heading is inserted there. Otherwise, it's inserted as own item. * Add support for manually inserting decorators for an existing item (`uiLayout.prop_decorator()`). That way layout creators can manually insert this, which was the only way I saw to support property split layouts with a checkbox before the actual property. {F8471883} * Autogenerated layouts for operator properties look bad if there are only checkboxes (which only use half the region width). So before creating the layout, we iterate over visible properties and disable split layout if all are booleans. I think this is fine, if needed we could also add layout hints to operators. * `uiTemplateOperatorPropertyButs()` now handles macros itself, the caller used to be responsible for this. Code that didn't handle these so far never used macros I think, so this change should be invisible. * Remove manual property split layout from autogenerated operator properties layout. * Padding of checkboxes is tweaked to make their label visually more connected to the checkboxes. * Support split layout for menus (should work for `uiLayout.menu()`, `.operator_menu_enum()`, `.prop_menu_enum()`, maybe more) Maniphest Task: https://developer.blender.org/T65965 Differential Revision: https://developer.blender.org/D7427 Reviewed by: Brecht Van Lommel, William Reynish, Pablo Vazques
2020-04-17 16:40:25 +02:00
/** Do not add the usual horizontal padding for text drawing. */
UI: Refactor quick label tooltip implementation for buttons No user visible changes expected. Used in the asset shelf branch, see #104831. These tooltips only show a label string and appear after a shorter timeout than the regular tooltips. After the regular tooltip timeout they expand to the full tooltip. The toolbar and properties editor navigation tabs make use of this already. The changes here enable more control over quick label tooltips, making them usable in more cases, and less ad-hoc. Main changes: - Refactors internal logic so a single `UI_BUT_HAS_TOOLTIP_LABEL` button flag can be used to enable quick label tooltips. This decentralizes logic in a way that's more consistent and extensible. - Custom callback to return a quick label. This is useful when a label tooltip should be displayed even when there is no button string set. E.g. in the asset shelf with "Show Names" disabled. Pull Request: https://projects.blender.org/blender/blender/pulls/110200
2023-07-25 16:22:31 +02:00
UI_BUT_NO_TEXT_PADDING = 1 << 6,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: minor comment correction
2017-11-03 01:10:03 +11:00
/* Button align flag, for drawing groups together.
* Used in 'uiBlock.flag', take care! */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BUT_ALIGN_TOP = 1 << 14,
UI_BUT_ALIGN_LEFT = 1 << 15,
UI_BUT_ALIGN_RIGHT = 1 << 16,
UI_BUT_ALIGN_DOWN = 1 << 17,
UI_BUT_ALIGN = UI_BUT_ALIGN_TOP | UI_BUT_ALIGN_LEFT | UI_BUT_ALIGN_RIGHT | UI_BUT_ALIGN_DOWN,
Cleanup: minor comment correction
2017-11-03 01:10:03 +11:00
/* end bits shared with 'uiBlock.flag' */
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/**
* Warning - HACK!
* Needed for buttons which are not TOP/LEFT aligned,
* but have some top/left corner stitched to some other TOP/LEFT-aligned button,
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
* because of "corrective" hack in #widget_roundbox_set().
*/
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BUT_ALIGN_STITCH_TOP = 1 << 18,
UI_BUT_ALIGN_STITCH_LEFT = 1 << 19,
UI_BUT_ALIGN_ALL = UI_BUT_ALIGN | UI_BUT_ALIGN_STITCH_TOP | UI_BUT_ALIGN_STITCH_LEFT,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** This but is "inside" a box item (currently used to change theme colors). */
UI_BUT_BOX_ITEM = 1 << 20,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** Active left part of number button */
UI_BUT_ACTIVE_LEFT = 1 << 21,
/** Active right part of number button */
UI_BUT_ACTIVE_RIGHT = 1 << 22,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** Reverse order of consecutive off/on icons */
UI: Support right aligned non-shortcut hints in widgets Widget drawing code already supported drawing right-aligned, grayed out shortcut strings. This patch generalizes things a bit so this can also be used to draw other hints in the same way. There have been a few instances in the past where this would've been useful, D11046 being the latest one. Note that besides some manual regression testing, I didn't check if this works yet, as there is no code actually using it (other than the shortcuts). Can be checked as part of further development for D11046. A possible further improvement would be providing a way to define how clipping should be done. E.g. sometimes the right-aligned text should be clipped first (because it's just a hint), in other cases it should be left untouched (like current code explicitly does it for shortcuts). Removes the `UI_BUT_HAS_SHORTCUT` flag, which isn't needed anymore.
2021-06-15 18:53:32 +02:00
UI_BUT_ICON_REVERSE = 1 << 23,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** Value is animated, but the current value differs from the animated one. */
UI: Support right aligned non-shortcut hints in widgets Widget drawing code already supported drawing right-aligned, grayed out shortcut strings. This patch generalizes things a bit so this can also be used to draw other hints in the same way. There have been a few instances in the past where this would've been useful, D11046 being the latest one. Note that besides some manual regression testing, I didn't check if this works yet, as there is no code actually using it (other than the shortcuts). Can be checked as part of further development for D11046. A possible further improvement would be providing a way to define how clipping should be done. E.g. sometimes the right-aligned text should be clipped first (because it's just a hint), in other cases it should be left untouched (like current code explicitly does it for shortcuts). Removes the `UI_BUT_HAS_SHORTCUT` flag, which isn't needed anymore.
2021-06-15 18:53:32 +02:00
UI_BUT_ANIMATED_CHANGED = 1 << 24,
UI: add Visibility panel for objects The outliner should not be the only way for users to change these settings. The Python API was extended to keep these properties positive and keyframable. Differential Revision: https://developer.blender.org/D4889
2019-05-20 12:14:48 +02:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Draw the checkbox buttons inverted. */
UI: Support right aligned non-shortcut hints in widgets Widget drawing code already supported drawing right-aligned, grayed out shortcut strings. This patch generalizes things a bit so this can also be used to draw other hints in the same way. There have been a few instances in the past where this would've been useful, D11046 being the latest one. Note that besides some manual regression testing, I didn't check if this works yet, as there is no code actually using it (other than the shortcuts). Can be checked as part of further development for D11046. A possible further improvement would be providing a way to define how clipping should be done. E.g. sometimes the right-aligned text should be clipped first (because it's just a hint), in other cases it should be left untouched (like current code explicitly does it for shortcuts). Removes the `UI_BUT_HAS_SHORTCUT` flag, which isn't needed anymore.
2021-06-15 18:53:32 +02:00
UI_BUT_CHECKBOX_INVERT = 1 << 25,
UI: Indeterminate Button State No user visible changes expected, the new button state is not used yet. Setting a new uiBut drawflag shows items in an indeterminate state, not indicating a specific value or state. Pull Request: https://projects.blender.org/blender/blender/pulls/108210
2023-07-17 19:37:15 +02:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Drawn in a way that indicates that the state/value is unknown. */
UI: Indeterminate Button State No user visible changes expected, the new button state is not used yet. Setting a new uiBut drawflag shows items in an indeterminate state, not indicating a specific value or state. Pull Request: https://projects.blender.org/blender/blender/pulls/108210
2023-07-17 19:37:15 +02:00
UI_BUT_INDETERMINATE = 1 << 26,
Squashed commit of the following: commit 6f97e194e58aab38d351c796bf7bb6abca33f5f9 Author: Bastien Montagne <montagne29@wanadoo.fr> Date: Wed Nov 20 21:18:20 2013 +0100 Code cleanup: Move some uiBut->flag to uiBut->drawflag, make those flags anonymous enums. Summary: Make some room in but->flag (I did not add another flag, we already have drawflag, which was nearly not used up till now). Note: I’m not sure whether REDALERT (and perhaps even DISABLED?) should not go to but->drawflag as well... Related to D8 Reviewers: brecht Differential Revision: http://developer.blender.org/D22
2013-11-21 14:43:08 +01:00
};
Finish changes in up/down arrows for menus Restored single triangle for special menus, which still isn't perfect but probably makes more sense. Added drawflag bit flags to button, which is currently used to declare, that button need to have up/down arrows. This is needed because it's tricky to distinguish if button should have such arrows. For example, ID search buttons is a simple block button which doesn't directly mean it'll have pop-up menu and not all buttons which cases pop-up menu to display need to have such arrows. So currently only ID selector button is forcing up/down arrows to be displayed, all the rest buttons now behaves in the same way as it used to be before.
2012-05-23 14:24:40 +00:00
Cleanup: spelling
2020-07-07 12:44:47 +10:00
/**
* Button types, bits stored in 1 value... and a short even!
* - bits 0-4: #uiBut.bitnr (0-31)
style cleanup - use aligned * prefixed blocks for descriptive comments (was already used a lot and part of proposed style guide).
2012-03-03 16:31:46 +00:00
* - bits 5-7: pointer type
* - bit 8: for 'bit'
* - bit 9-15: button type (now 6 bits, 64 types)
Cleanup: spelling
2020-07-07 12:44:47 +10:00
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
enum eButPointerType {
UI: Make uiBut safe for non-trivial construction No user-visible changes expected. Essentially, this makes it possible to use C++ types like `std::function` inside `uiBut`. This has plenty of benefits, for example this should help significantly reducing unsafe `void *` use (since a `std::function` can hold arbitrary data while preserving types). ---- I wanted to use a non-trivially-constructible C++ type (`std::function`) inside `uiBut`. But this would mean we can't use `MEM_cnew()` like allocation anymore. Rather than writing worse code, allow non-trivial construction for `uiBut`. Member-initializing all members is annoying since there are so many, but rather safe than sorry. As we use more C++ types (e.g. convert callbacks to use `std::function`), this should become less since they initialize properly on default construction. Also use proper C++ inheritance for `uiBut` subtypes, the old way to allocate based on size isn't working anymore. Differential Revision: https://developer.blender.org/D17164 Reviewed by: Hans Goudey
2023-02-03 16:12:14 +01:00
UI_BUT_POIN_NONE = 0,
code cleanup: changing the INT define to an enum conflicts with INT typedef on windows, use more verbose names for button pointer types. also removed some redundant flags from buttons.
2012-09-12 00:32:33 +00:00
UI_BUT_POIN_CHAR = 32,
UI_BUT_POIN_SHORT = 64,
UI_BUT_POIN_INT = 96,
UI_BUT_POIN_FLOAT = 128,
Cleanup: full sentences in comments, improve comment formatting
2021-06-26 21:35:18 +10:00
// UI_BUT_POIN_FUNCTION = 192, /* UNUSED */
UI_BUT_POIN_BIT = 256, /* OR'd with a bit index. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** \note requires `but->poin != NULL`. */
code cleanup: changing the INT define to an enum conflicts with INT typedef on windows, use more verbose names for button pointer types. also removed some redundant flags from buttons.
2012-09-12 00:32:33 +00:00
#define UI_BUT_POIN_TYPES (UI_BUT_POIN_FLOAT | UI_BUT_POIN_SHORT | UI_BUT_POIN_CHAR)
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/**
* #uiBut::type
* OR'd with #eButPointerType when passing as an argument.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
enum eButType {
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BTYPE_BUT = 1 << 9,
UI_BTYPE_ROW = 2 << 9,
UI_BTYPE_TEXT = 3 << 9,
Cleanup: spelling
2020-09-16 15:28:02 +10:00
/** Drop-down list. */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BTYPE_MENU = 4 << 9,
UI_BTYPE_BUT_MENU = 5 << 9,
/** number button */
UI_BTYPE_NUM = 6 << 9,
/** number slider */
UI_BTYPE_NUM_SLIDER = 7 << 9,
UI_BTYPE_TOGGLE = 8 << 9,
UI_BTYPE_TOGGLE_N = 9 << 9,
UI_BTYPE_ICON_TOGGLE = 10 << 9,
UI_BTYPE_ICON_TOGGLE_N = 11 << 9,
/** same as regular toggle, but no on/off state displayed */
UI_BTYPE_BUT_TOGGLE = 12 << 9,
/** similar to toggle, display a 'tick' */
UI_BTYPE_CHECKBOX = 13 << 9,
UI_BTYPE_CHECKBOX_N = 14 << 9,
UI_BTYPE_COLOR = 15 << 9,
UI_BTYPE_TAB = 16 << 9,
UI_BTYPE_POPOVER = 17 << 9,
UI_BTYPE_SCROLL = 18 << 9,
UI_BTYPE_BLOCK = 19 << 9,
UI_BTYPE_LABEL = 20 << 9,
UI_BTYPE_KEY_EVENT = 24 << 9,
UI_BTYPE_HSVCUBE = 26 << 9,
Cleanup: spelling in comments, correct doxy slashes, replace '/w'
2022-09-07 12:52:05 +10:00
/** Menu (often used in headers), `*_MENU` with different draw-type. */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BTYPE_PULLDOWN = 27 << 9,
UI_BTYPE_ROUNDBOX = 28 << 9,
UI_BTYPE_COLORBAND = 30 << 9,
/** sphere widget (used to input a unit-vector, aka normal) */
UI_BTYPE_UNITVEC = 31 << 9,
UI_BTYPE_CURVE = 32 << 9,
Bevel: Custom Profile and CurveProfile Widget Custom profiles in bevel allows the profile curve to be controlled by manually placed control points. Orientation is regularized along groups of edges, and the 'pipe case' is updated. This commit includes many updates to comments and changed variable names as well. A 'cutoff' vertex mesh method is added to bevel in addition to the existing grid fill option for replacing vertices. The UI of the bevel modifier and tool are updated and unified. Also, a 'CurveProfile' widget is added to BKE for defining the profile in the interface, which may be useful in other situations. Many thanks to Howard, my mentor for this GSoC project. Reviewers: howardt, campbellbarton Differential Revision: https://developer.blender.org/D5516
2019-11-20 16:12:32 -05:00
/** Profile editing widget */
UI_BTYPE_CURVEPROFILE = 33 << 9,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BTYPE_LISTBOX = 36 << 9,
UI_BTYPE_LISTROW = 37 << 9,
UI_BTYPE_HSVCIRCLE = 38 << 9,
UI_BTYPE_TRACK_PREVIEW = 40 << 9,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** Buttons with value >= #UI_BTYPE_SEARCH_MENU don't get undo pushes. */
UI_BTYPE_SEARCH_MENU = 41 << 9,
UI_BTYPE_EXTRA = 42 << 9,
UI: New button/widget type for Asset Browser like preview tiles This button type shows a preview image above centered text, similar to the File Browser files in Thumbnail Display Mode or the default Asset Browser display. In fact we may want to port these over to use the new button type at some point. Will be used by the asset view UI template that will be added in a following commit. That is basically a mini version of the Asset Browser that can be displayed elsewhere in the UI.
2021-07-13 17:30:34 +02:00
/** A preview image (#PreviewImage), with text under it. Typically bigger than normal buttons and
* laid out in a grid, e.g. like the File Browser in thumbnail display mode. */
UI_BTYPE_PREVIEW_TILE = 43 << 9,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BTYPE_HOTKEY_EVENT = 46 << 9,
/** Non-interactive image, used for splash screen */
UI_BTYPE_IMAGE = 47 << 9,
UI_BTYPE_HISTOGRAM = 48 << 9,
UI_BTYPE_WAVEFORM = 49 << 9,
UI_BTYPE_VECTORSCOPE = 50 << 9,
Cleanup: rename uiButProgressbar to uiButProgress Prepare for other types of progress to be added.
2023-07-12 13:15:39 +10:00
UI_BTYPE_PROGRESS = 51 << 9,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BTYPE_NODE_SOCKET = 53 << 9,
UI_BTYPE_SEPR = 54 << 9,
UI_BTYPE_SEPR_LINE = 55 << 9,
/** Dynamically fill available space. */
UI_BTYPE_SEPR_SPACER = 56 << 9,
Cleanup: spelling in comments
2023-01-20 15:19:32 +11:00
/** Resize handle (resize UI-list). */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_BTYPE_GRIP = 57 << 9,
UI Code Quality: Use derived structs for search buttons and decorators The current on-size-fits-all `uiBut` creates quite a mess, where it's hard to reason about which members are free for use, under which conditions they are used and how. `uiBut` also has members that aren't used at times, violating the "don't pay for what you don't use" principle. To address this, we want to move to typed buttons, where `uiBut` is just a base struct and each type extends it as needed. That structures data better and type specific data is only available if it's actually used by a button type. Two trade-offs: * Many casts to the derived type have to be done. * Sometimes we change the button type after it's created. So I had to add logic to reallocate the button for use with the new, possibly derived struct. Ideally that wouldn't be needed, but for now that's what we have. Part of T74432. Differential Revision: https://developer.blender.org/D7610 Reviewed by: Brecht Van Lommel, Campbell Barton
2020-08-07 14:34:11 +02:00
UI_BTYPE_DECORATOR = 58 << 9,
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** An item a view (see #ui::AbstractViewItem). */
UI: Port view item features to base class, merge view item button types No user visible changes expected. Merges the tree row and grid tile button types, which were mostly doing the same things. The idea is that there is a button type for highlighting, as well as supporting general view item features (e.g. renaming, drag/drop, etc.). So instead there is a view item button type now. Also ports view item features like renaming, custom context menus, drag controllers and drop controllers to `ui::AbstractViewItem` (the new base class for all view items). This should be quite an improvement because: - Merges code that was duplicated over view items. - Mentioned features (renaming, drag & drop, ...) are much easier to implement in new view types now. Most of it comes "for free". - Further features will immediately become availalbe to all views (e.g. selection). - Simplifies APIs, there don't have to be functions for individual view item types anymore. - View item classes are split and thus less overwhelming visually. - View item buttons now share all code (drawing, handling, etc.) - We're soon running out of available button types, this commit merges two into one. I was hoping I could do this in multiple smaller commits, but things were quite intertwined so that would've taken quite some effort.
2022-07-19 16:14:42 +02:00
UI_BTYPE_VIEW_ITEM = 59 << 9,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
#define BUTTYPE (63 << 9)
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/** Gradient types, for color picker #UI_BTYPE_HSVCUBE etc. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
enum eButGradientType {
Cleanup: quiet ASAN warning with invalid value for eButGradientType -1 was assigned to eButGradientType which isn't a valid value, add UI_GRAD_NONE to resolve this.
2023-09-27 14:28:47 +10:00
UI_GRAD_NONE = -1,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_GRAD_SV = 0,
UI_GRAD_HV = 1,
UI_GRAD_HS = 2,
UI_GRAD_H = 3,
UI_GRAD_S = 4,
UI_GRAD_V = 5,
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_GRAD_V_ALT = 9,
UI_GRAD_L_ALT = 10,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
New Compositor node: Hue Control Was very quick to do, now re-aquainted with node editor. http://mke3.net/blender/devel/2.5/hue_correct_node.jpg Todo: modes for affecting hue and value on the vertical axis as well as just saturation - or if an enterprising coder wants to give it a go, let me know and I can help :)
2010-01-21 00:00:45 +00:00
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
/* Drawing
*
* Functions to draw various shapes, taking theme settings into account.
* Used for code that draws its own UI style elements. */
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_draw_roundbox_corner_set(int type);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_draw_roundbox_aa(const rctf *rect, bool filled, float rad, const float color[4]);
void UI_draw_roundbox_4fv(const rctf *rect, bool filled, float rad, const float col[4]);
void UI_draw_roundbox_3ub_alpha(
const rctf *rect, bool filled, float rad, const unsigned char col[3], unsigned char alpha);
Cleanup: pass 'rctf' rectangle to 2D box drawing functions Passing 4x arguments for the rectangle, mixed in with round-box radius & color wasn't very readable. Instead, pass a `rctf` as the first argument to UI box drawing functions.
2021-01-25 18:31:11 +11:00
void UI_draw_roundbox_3fv_alpha(
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const rctf *rect, bool filled, float rad, const float col[3], float alpha);
void UI_draw_roundbox_4fv_ex(const rctf *rect,
UI: Viewport Navigate Gizmo Refactor Simplification and changes to the Navigation gizmo. Better indication of negative axes, consistent use of color and size to indicate orientation, ability to be resized. Differential Revision: https://developer.blender.org/D9744 Reviewed by Campbell Barton
2021-01-23 13:10:07 -08:00
const float inner1[4],
const float inner2[4],
float shade_dir,
UI: Round-box drawing cleanup The new GPU_SHADER_2D_WIDGET_BASE shader allows us to draw many complex shapes with anti-aliasing. One thing it can do is draw an opaque rounded rectangle with colors that differ between its interior and outline. In order to do the above in a single pass I recently added an "_ex" version of UI_draw_roundbox that exposes most of that shaders features. This simplifies interface_draw.c by removing redundancy in the calling of this shader by using this new uber "_ex" version. Ref D10189
2021-01-25 18:02:55 +11:00
const float outline[4],
UI: Viewport Navigate Gizmo Refactor Simplification and changes to the Navigation gizmo. Better indication of negative axes, consistent use of color and size to indicate orientation, ability to be resized. Differential Revision: https://developer.blender.org/D9744 Reviewed by Campbell Barton
2021-01-23 13:10:07 -08:00
float outline_width,
float rad);
OpenGL: refactor UI_draw_roundbox functions Each function takes a bool (filled vs outline) and a color. We already had multiple ways of passing color in; these are still here. Special variant for anti-aliasing. - took GLenum out of interface - removed UI_RB_ALPHA flag (only one place really used it) - use exact vertex count - removed redundant state changes (BLEND, LINE_SMOOTH)
2017-04-06 19:15:26 -04:00
#if 0 /* unused */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int UI_draw_roundbox_corner_get();
OpenGL: refactor UI_draw_roundbox functions Each function takes a bool (filled vs outline) and a color. We already had multiple ways of passing color in; these are still here. Special variant for anti-aliasing. - took GLenum out of interface - removed UI_RB_ALPHA flag (only one place really used it) - use exact vertex count - removed redundant state changes (BLEND, LINE_SMOOTH)
2017-04-06 19:15:26 -04:00
#endif
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_draw_box_shadow(const rctf *rect, unsigned char alpha);
OpenGL immediate mode: interface_draw.c (cont) ui_draw_but_HISTOGRAM UI_draw_text_underline (untested)
2017-02-06 16:54:26 +01:00
void UI_draw_text_underline(int pos_x, int pos_y, int len, int height, const float color[4]);
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Draw title and text safe areas.
*
* \note This function is to be used with the 2D dashed shader enabled.
*
* \param pos: is a #PRIM_FLOAT, 2, #GPU_FETCH_FLOAT vertex attribute.
Cleanup: resolve parameter mis-matches in doc-strings Renamed or removed parameters which no longer exist.
2021-12-14 18:35:23 +11:00
* \param rect: The offsets for the view, not the zones.
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
Reworked version of dashed line shader. Using geometry shader allows us to get rid of the 'line origin' extra vertex attribute, which means dashed shader no longer requires fiddling with those vertex attributes definition, and, most importantly, does not require anymore special drawing code! As you can see, this makes code much simpler, and much less verbose, especially in complex cases. In addition, changed how dashes are handled, to have two 'modes', a simple one with single color (using default "color" uniform name), and a more advanced one allowing more complex and multi-color patterns. Note that since GLSL 1.2 does not support geometry shaders, a hack was added for now (which gives solid lines, but at least does not make Blender crash).
2017-05-01 16:21:53 +02:00
void UI_draw_safe_areas(uint pos,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const rctf *rect,
Viewport: Add adjustable safe areas, 3d-view & VSE Also adds safe-area presets. D325 by Diego Gangl with own edits.
2015-01-19 16:30:35 +11:00
const float title_aspect[2],
const float action_aspect[2]);
Cleanup: spelling in comments
2023-01-20 15:19:32 +11:00
/** State for scroll-drawing. */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
enum {
UI_SCROLL_PRESSED = 1 << 0,
UI_SCROLL_ARROWS = 1 << 1,
};
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Function in use for buttons and for view2d sliders.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_draw_widget_scroll(uiWidgetColors *wcol, const rcti *rect, const rcti *slider, int state);
2.5 Upgrading text editor to draw new scrollbar too.
2009-07-03 10:54:39 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Shortening string helper.
*
* Cut off the middle of the text to fit into the given width.
*
* \note in case this middle clipping would just remove a few chars,
* it rather clips right, which is more readable.
*
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
* If `rpart_sep` is not null, the part of `str` starting to first occurrence of `rpart_sep`
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
* is preserved at all cost.
* Useful for strings with shortcuts
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
* (like `A Very Long Foo Bar Label For Menu Entry|Ctrl O' -> 'AVeryLong...MenuEntry|Ctrl O`).
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
float UI_text_clip_middle_ex(const uiFontStyle *fstyle,
UI: refactor layout vars out of uiFontStyle Word wrap and alignment layout args only used by UI_fontstyle_draw were vars in uiFontStyle. These were written to before drawing, so better pass as an argument. Pass uiFontStyle & uiWidgetColors as const args.
2019-01-04 09:58:03 +11:00
char *str,
float okwidth,
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
float minwidth,
Revert "BLI: Refactor vector types & functions to use templates" Includes unwanted changes This reverts commit 46e049d0ce2bce2f53ddc41a0dbbea2969d00a5d.
2022-01-12 12:49:36 +01:00
size_t max_len,
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
char rpart_sep);
Cleanup: deduplicate code. FileBrowser had its own 'shorten_string' func, when we have a full fledge one in interface_widget code...
2015-05-04 21:12:28 +02:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/**
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
* Callbacks.
Fix #29306: Alt+N, Enter In Image View Does closes the dialog without executing. If enter is pressed outside of any button in menu, generate two menu return values: - UI_RETURN_CANCEL so button wouldn't be executed - UI_RETURN_POPUP_OK so callback associated with popup block would be executed
2011-11-24 13:51:31 +00:00
*
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
* #UI_block_func_handle_set/ButmFunc are for handling events through a callback.
Fix #29306: Alt+N, Enter In Image View Does closes the dialog without executing. If enter is pressed outside of any button in menu, generate two menu return values: - UI_RETURN_CANCEL so button wouldn't be executed - UI_RETURN_POPUP_OK so callback associated with popup block would be executed
2011-11-24 13:51:31 +00:00
* HandleFunc gets the retval passed on, and ButmFunc gets a2. The latter is
* mostly for compatibility with older code.
*
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
* - #UI_but_func_complete_set is for tab completion.
Fix #29306: Alt+N, Enter In Image View Does closes the dialog without executing. If enter is pressed outside of any button in menu, generate two menu return values: - UI_RETURN_CANCEL so button wouldn't be executed - UI_RETURN_POPUP_OK so callback associated with popup block would be executed
2011-11-24 13:51:31 +00:00
*
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
* - #uiButSearchFunc is for name buttons, showing a popup with matches
Fix #29306: Alt+N, Enter In Image View Does closes the dialog without executing. If enter is pressed outside of any button in menu, generate two menu return values: - UI_RETURN_CANCEL so button wouldn't be executed - UI_RETURN_POPUP_OK so callback associated with popup block would be executed
2011-11-24 13:51:31 +00:00
*
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
* - #UI_block_func_set and UI_but_func_set are callbacks run when a button is used,
* in case events, operators or RNA are not sufficient to handle the button.
Fix #29306: Alt+N, Enter In Image View Does closes the dialog without executing. If enter is pressed outside of any button in menu, generate two menu return values: - UI_RETURN_CANCEL so button wouldn't be executed - UI_RETURN_POPUP_OK so callback associated with popup block would be executed
2011-11-24 13:51:31 +00:00
*
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
* - #UI_but_funcN_set will free the argument with MEM_freeN. */
Fix #29306: Alt+N, Enter In Image View Does closes the dialog without executing. If enter is pressed outside of any button in menu, generate two menu return values: - UI_RETURN_CANCEL so button wouldn't be executed - UI_RETURN_POPUP_OK so callback associated with popup block would be executed
2011-11-24 13:51:31 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiSearchItems;
Fix #29306: Alt+N, Enter In Image View Does closes the dialog without executing. If enter is pressed outside of any button in menu, generate two menu return values: - UI_RETURN_CANCEL so button wouldn't be executed - UI_RETURN_POPUP_OK so callback associated with popup block would be executed
2011-11-24 13:51:31 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiButHandleFunc = void (*)(bContext *C, void *arg1, void *arg2);
using uiButHandleRenameFunc = void (*)(bContext *C, void *arg, char *origstr);
using uiButHandleNFunc = void (*)(bContext *C, void *argN, void *arg2);
using uiButHandleHoldFunc = void (*)(bContext *C, ARegion *butregion, uiBut *but);
using uiButCompleteFunc = int (*)(bContext *C, char *str, void *arg);
UI: add menu search functionality to operator search menu This has some advantages over operator search: - Some operators need options set to be usefully accessed. - Shows key bindings to access menus (for actions that don't have key bindings themselves). - Non operator actions such as check-boxes are also shown. - Menu items can control execution context, using invoke or execute where appropriate so we can control how the operator runs. Part of the design task T74157. This can be tested using the 'Experimental' preferences section or selected in the key-map editor.
2020-03-24 11:34:18 +11:00
UI: Add callback for comparing button identity The code to compare buttons from the previous to the current frame, to see if they match (an thus should keep the same state) was quite generic, and didn't allow much flexibility/customization. For some cases this isn't enough, and a more specific comparison is needed. Say if some buttons don't actually store comparable data themselves, only via the button context. This was the case in D14653.
2022-04-26 22:26:15 +02:00
/** Function to compare the identity of two buttons over redraws, to check if they represent the
* same data, and thus should be considered the same button over redraws. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiButIdentityCompareFunc = bool (*)(const uiBut *a, const uiBut *b);
UI: Add callback for comparing button identity The code to compare buttons from the previous to the current frame, to see if they match (an thus should keep the same state) was quite generic, and didn't allow much flexibility/customization. For some cases this isn't enough, and a more specific comparison is needed. Say if some buttons don't actually store comparable data themselves, only via the button context. This was the case in D14653.
2022-04-26 22:26:15 +02:00
Cleanup: split button search callbacks into their own struct
2020-05-07 23:16:05 +10:00
/* Search types. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiButSearchCreateFn = ARegion *(*)(bContext *C, ARegion *butregion, uiButSearch *search_but);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* `is_first` is typically used to ignore search filtering when the menu is first opened in order
UI: Expose an "is first search" boolean to search button callbacks Currently when you open an RNA collection search button, like a vertex group selector, the search filter isn't applied until you start typing, in order to display every option at the start. Otherwise they wouldn't be visible, since the search filter would run for the current text. Currently this check happens in one place, but it relies on the `changed` value of `uiBut`. This is fine in the interface directory, but anywhere else it would require exposing `uiBut.changed`, which is probably too low-level to expose. The solution is adding an `is_first` argument to the search callbacks, which is nice for a few reasons: - They work at a higher level of abstraction, meaning they don't have to worry about how exactly to tell if this is the first search. - It makes it easier to do special behavior when the search menu is first opened. - Then, obviously, it makes that state accessible without including `interface_intern.h`. Needed for attribute search: T85658 Differential Revision: https://developer.blender.org/D10528
2021-03-02 11:42:05 -06:00
* to display the full list of options. The value will be false after the button's text is edited
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
* (for every call except the first).
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiButSearchUpdateFn =
void (*)(const bContext *C, void *arg, const char *str, uiSearchItems *items, bool is_first);
using uiButSearchContextMenuFn = bool (*)(bContext *C,
void *arg,
void *active,
const wmEvent *event);
using uiButSearchTooltipFn =
ARegion *(*)(bContext *C, ARegion *region, const rcti *item_rect, void *arg, void *active);
using uiButSearchListenFn = void (*)(const wmRegionListenerParams *params, void *arg);
UI: add menu search functionality to operator search menu This has some advantages over operator search: - Some operators need options set to be usefully accessed. - Shows key bindings to access menus (for actions that don't have key bindings themselves). - Non operator actions such as check-boxes are also shown. - Menu items can control execution context, using invoke or execute where appropriate so we can control how the operator runs. Part of the design task T74157. This can be tested using the 'Experimental' preferences section or selected in the key-map editor.
2020-03-24 11:34:18 +11:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Must return an allocated string. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiButToolTipFunc = char *(*)(bContext *C, void *argN, const char *tip);
UI: add optional tip callback to uiBut, and use it for per-item tooltips in UIList. When defined, uiBut->tip_func is called when button's tip is generated. This allows for advanced, dynamic generation of tooltips. For now, only used by UIList, which can now optionaly use a given string property of each item for its tooltip. Thanks to Campbell for the reviews!
2015-02-11 00:06:03 +01:00
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
using uiButToolTipCustomFunc = void (*)(bContext *C, uiTooltipData *data, void *argN);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiBlockHandleFunc = void (*)(bContext *C, void *arg, int event);
Fix #29306: Alt+N, Enter In Image View Does closes the dialog without executing. If enter is pressed outside of any button in menu, generate two menu return values: - UI_RETURN_CANCEL so button wouldn't be executed - UI_RETURN_POPUP_OK so callback associated with popup block would be executed
2011-11-24 13:51:31 +00:00
UI: support persistent state during number/slider interaction Support for begin/update/end callbacks allowing state to be cached and reused while dragging a number button or slider. This is done using `UI_block_interaction_set` to set callbacks. - Dragging multiple buttons at once is supported, passing multiple unique events into the update function. - Update is only called once even when multiple buttons are edited. - The update callback can detect the difference between click & drag actions so situations to support skipping cache creation and freeing for situations where it's not beneficial. Reviewed by: Severin, HooglyBoogly Ref D11861
2021-07-08 16:23:41 +10:00
/* -------------------------------------------------------------------- */
/** \name Custom Interaction
*
* Sometimes it's useful to create data that remains available
* while the user interacts with a button.
*
* A common case is dragging a number button or slider
* however this could be used in other cases too.
* \{ */
struct uiBlockInteraction_Params {
/**
* When true, this interaction is not modal
* (user clicking on a number button arrows or pasting a value for example).
*/
bool is_click;
/**
* Array of unique event ID's (values from #uiBut.retval).
* There may be more than one for multi-button editing (see #UI_BUT_DRAG_MULTI).
*/
int *unique_retval_ids;
uint unique_retval_ids_len;
};
/** Returns 'user_data', freed by #uiBlockInteractionEndFn. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiBlockInteractionBeginFn = void *(*)(bContext *C,
const uiBlockInteraction_Params *params,
void *arg1);
using uiBlockInteractionEndFn = void (*)(bContext *C,
const uiBlockInteraction_Params *params,
void *arg1,
void *user_data);
using uiBlockInteractionUpdateFn = void (*)(bContext *C,
const uiBlockInteraction_Params *params,
void *arg1,
void *user_data);
struct uiBlockInteraction_CallbackData {
UI: support persistent state during number/slider interaction Support for begin/update/end callbacks allowing state to be cached and reused while dragging a number button or slider. This is done using `UI_block_interaction_set` to set callbacks. - Dragging multiple buttons at once is supported, passing multiple unique events into the update function. - Update is only called once even when multiple buttons are edited. - The update callback can detect the difference between click & drag actions so situations to support skipping cache creation and freeing for situations where it's not beneficial. Reviewed by: Severin, HooglyBoogly Ref D11861
2021-07-08 16:23:41 +10:00
uiBlockInteractionBeginFn begin_fn;
uiBlockInteractionEndFn end_fn;
uiBlockInteractionUpdateFn update_fn;
void *arg1;
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
UI: support persistent state during number/slider interaction Support for begin/update/end callbacks allowing state to be cached and reused while dragging a number button or slider. This is done using `UI_block_interaction_set` to set callbacks. - Dragging multiple buttons at once is supported, passing multiple unique events into the update function. - Update is only called once even when multiple buttons are edited. - The update callback can detect the difference between click & drag actions so situations to support skipping cache creation and freeing for situations where it's not beneficial. Reviewed by: Severin, HooglyBoogly Ref D11861
2021-07-08 16:23:41 +10:00
void UI_block_interaction_set(uiBlock *block, uiBlockInteraction_CallbackData *callbacks);
/** \} */
UI * Headers and menus can now be created in python. * Replaced the uiMenuItem functions to create menus with equivalent uiItem functions using a layout, removing duplicated code. * More uiItem functions are now exposed to python. * The text editor header, panels and one of its menus are now created in space_text.py. * Buttons window data context icon new changes depending on active object. Issues * Icons are not wrapped yet, hardcoded ints at the moment. * The ID browse template is unfinished.
2009-04-22 18:39:44 +00:00
/* Menu Callbacks */
2.5 Simple toolbox-style menu system. Brecht will review it though, and/or check on way to use it for menus. I tried to avoid uiBlock and rna stuff all over. :) Quick image test: http://www.blender.org/bf/rt.jpg Examples you can read in: - editors/screen/screen_ops.c:testing123() (press F5) - editors/object/object_edit.c:object_add_primitive_invoke() (press SHIFT+A) Concept is simple: uiMenuBegin(): returns a handle. uiMenuEnd(): puts it all to work. In between you can add items like: uiMenuItemVal(): a name, icon, retval (use uiMenuFunc()) uiMenuItemO(): an operator + icon uiMenuItemEnumO(): an operator, property name, value Sublevels go easy too: uiMenuLevel(): creates item for sublevel, with function pointer. Inside that function you can use all menu calls again. Levels can go as deep you want. uiMenuLevelEnumO(): creates operator sublevel for an enum
2009-01-25 20:22:05 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiMenuCreateFunc = void (*)(bContext *C, uiLayout *layout, void *arg1);
using uiMenuHandleFunc = void (*)(bContext *C, void *arg, int event);
UI: support cycling callback for non RNA menus
2015-11-16 06:26:25 +11:00
/**
* Used for cycling menu values without opening the menu (Ctrl-Wheel).
* \param direction: forward or backwards [1 / -1].
* \param arg1: uiBut.poin (as with #uiMenuCreateFunc).
* \return true when the button was changed.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiMenuStepFunc = bool (*)(bContext *C, int direction, void *arg1);
2.5 Simple toolbox-style menu system. Brecht will review it though, and/or check on way to use it for menus. I tried to avoid uiBlock and rna stuff all over. :) Quick image test: http://www.blender.org/bf/rt.jpg Examples you can read in: - editors/screen/screen_ops.c:testing123() (press F5) - editors/object/object_edit.c:object_add_primitive_invoke() (press SHIFT+A) Concept is simple: uiMenuBegin(): returns a handle. uiMenuEnd(): puts it all to work. In between you can add items like: uiMenuItemVal(): a name, icon, retval (use uiMenuFunc()) uiMenuItemO(): an operator + icon uiMenuItemEnumO(): an operator, property name, value Sublevels go easy too: uiMenuLevel(): creates item for sublevel, with function pointer. Inside that function you can use all menu calls again. Levels can go as deep you want. uiMenuLevelEnumO(): creates operator sublevel for an enum
2009-01-25 20:22:05 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiCopyArgFunc = void *(*)(const void *arg);
using uiFreeArgFunc = void (*)(void *arg);
UI: custom free function improvements This changes `UI_but_func_tooltip_set` so that it allows passing a custom free function, which has two benefits: * The caller can pass `null` to indicate that the value should not be freed. * Arbitrary c++ data can be passed to the callback (before the struct had to be trivially destructible). I added `uiFreeArgFunc` and used it in other places where appropriate. Differential Revision: https://developer.blender.org/D11738
2021-06-30 17:27:54 +02:00
Cleanup: correct file names in comments after C -> C++ renaming Use back-tick quotes to differentiate these from plain text.
2023-07-31 11:50:54 +10:00
/* `interface_query.cc` */
Cleanup: ensure space after file named in headers Add blank lines after file references to avoid them being interpreted as doc-strings the following declarations.
2022-04-04 13:17:03 +10:00
UI: show a small label next to the tool Instead of showing the full tip immediately when hovering over a tool, show only the (label, shortcut), without suppressing the regular tip.
2018-09-05 13:52:19 +10:00
bool UI_but_has_tooltip_label(const uiBut *but);
UI: move queries into interface_query.c
2018-06-30 10:58:56 +02:00
bool UI_but_is_tool(const uiBut *but);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/* file selectors are exempt from utf-8 checks */
Expose button UTF8 check in UI_interface.h Used in following commit.
2019-09-04 16:19:48 +02:00
bool UI_but_is_utf8(const uiBut *but);
UI Code Quality: Use derived structs for search buttons and decorators The current on-size-fits-all `uiBut` creates quite a mess, where it's hard to reason about which members are free for use, under which conditions they are used and how. `uiBut` also has members that aren't used at times, violating the "don't pay for what you don't use" principle. To address this, we want to move to typed buttons, where `uiBut` is just a base struct and each type extends it as needed. That structures data better and type specific data is only available if it's actually used by a button type. Two trade-offs: * Many casts to the derived type have to be done. * Sometimes we change the button type after it's created. So I had to add logic to reallocate the button for use with the new, possibly derived struct. Ideally that wouldn't be needed, but for now that's what we have. Part of T74432. Differential Revision: https://developer.blender.org/D7610 Reviewed by: Brecht Van Lommel, Campbell Barton
2020-08-07 14:34:11 +02:00
#define UI_but_is_decorator(but) ((but)->type == UI_BTYPE_DECORATOR)
UI: move queries into interface_query.c
2018-06-30 10:58:56 +02:00
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
bool UI_block_is_empty_ex(const uiBlock *block, bool skip_title);
UI: Add 'interface_query.c' Interface files are increasingly mixing up too much functionality, add a file only to handle queries. More functions can be moved/added here.
2018-06-30 10:36:40 +02:00
bool UI_block_is_empty(const uiBlock *block);
UI: hide redundant menu separators automatically Differential Revision: https://developer.blender.org/D4682
2019-04-25 14:40:53 +02:00
bool UI_block_can_add_separator(const uiBlock *block);
UI: Add 'interface_query.c' Interface files are increasingly mixing up too much functionality, add a file only to handle queries. More functions can be moved/added here.
2018-06-30 10:36:40 +02:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiList *UI_list_find_mouse_over(const ARegion *region, const wmEvent *event);
UI: Internal support for custom UI list item drag & activate operators For pose libraries, we need to be able to apply a pose whenever activating (clicking) an item in the Pose Library asset view and blend it by dragging (press & move). And since we want to allow Python scripts to define what happens at least when activating an asset (so they can define for example a custom "Apply" operator for preset assets), it makes sense to just let them pass an operator name to the asset view template. The template will be introduced in a following commit.
2021-07-09 21:46:55 +02:00
Cleanup: correct file names in comments after C -> C++ renaming Use back-tick quotes to differentiate these from plain text.
2023-07-31 11:50:54 +10:00
/* `interface_region_menu_popup.cc` */
Cleanup: ensure space after file named in headers Add blank lines after file references to avoid them being interpreted as doc-strings the following declarations.
2022-04-04 13:17:03 +10:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/**
* Popup Menus
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
*
* Functions used to create popup menus. For more extended menus the
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
* UI_popup_menu_begin/End functions can be used to define own items with
- correct typos in comments. - move boxpack struct out of the public header.
2011-01-02 11:06:50 +00:00
* the uiItem functions in between. If it is a simple confirmation menu
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
* or similar, popups can be created with a single function call.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiPopupMenu;
UI * Headers and menus can now be created in python. * Replaced the uiMenuItem functions to create menus with equivalent uiItem functions using a layout, removing duplicated code. * More uiItem functions are now exposed to python. * The text editor header, panels and one of its menus are now created in space_text.py. * Buttons window data context icon new changes depending on active object. Issues * Icons are not wrapped yet, hardcoded ints at the moment. * The ID browse template is unfinished.
2009-04-22 18:39:44 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiPopupMenu *UI_popup_menu_begin(bContext *C, const char *title, int icon) ATTR_NONNULL();
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
Cleanup: move doc-strings into headers, remove duplicates In some cases move implementation details into the function body.
2023-03-29 14:16:31 +11:00
* Directly create a popup menu that is not refreshed on redraw.
*
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
* Only return handler, and set optional title.
* \param block_name: Assigned to uiBlock.name (useful info for debugging).
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiPopupMenu *UI_popup_menu_begin_ex(bContext *C,
More useful block name for report popup blocks Report popups simply reuse popup menu code, so their blocks got "UI_popup_menu_begin" assigned as name, which was a bit misleading. Now uses "UI_popup_menu_reports". Ideally they'd have their own popup code.
2016-07-26 19:30:18 +02:00
const char *title,
const char *block_name,
int icon) ATTR_NONNULL();
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Set the whole structure to work.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_popup_menu_end(bContext *C, uiPopupMenu *pup);
bool UI_popup_menu_end_or_cancel(bContext *C, uiPopupMenu *pup);
uiLayout *UI_popup_menu_layout(uiPopupMenu *pup);
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_popup_menu_reports(bContext *C, ReportList *reports) ATTR_NONNULL();
int UI_popup_menu_invoke(bContext *C, const char *idname, ReportList *reports) ATTR_NONNULL(1, 2);
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Allow setting menu return value from externals.
* E.g. WM might need to do this for exiting files correctly.
*/
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
void UI_popup_menu_retval_set(const uiBlock *block, int retval, bool enable);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Setting the button makes the popup open from the button instead of the cursor.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_popup_menu_but_set(uiPopupMenu *pup, ARegion *butregion, uiBut *but);
Fix T49199: Combination of dialog + wm.open_mainfile causes crash Issue was that the wm.open_mainfile OP caused all handlers to be removed and since rB45592291 cancelled (which is correct in general), the menu that triggered the OP should not be cancelled though. Not sure if this is a nice fix or not, it's however the safest fix I found. A different fix would be to call UI_popup_block_close before WM_operator_call_ex (in dialog_exec_cb), but not sure how safe this is and want to further investigate if it makes other hacks/fixes redundant. There's still a crash with --debug-memory that confused the heck out of me (since I always have --debug-memory enabled), but I'll commit fix for that separately.
2016-09-01 16:25:42 +02:00
Cleanup: correct file names in comments after C -> C++ renaming Use back-tick quotes to differentiate these from plain text.
2023-07-31 11:50:54 +10:00
/* `interface_region_popover.cc` */
UI: Initial popover support for panels - UILayout.popover(.. panel_type ..) A single panel - UILayout.popover_group(.. panel categories ..) Expands all panels matching args. Currently used in the topbar for redo and paint options.
2018-04-22 17:16:39 +02:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiPopover;
UI: Initial popover support for panels - UILayout.popover(.. panel_type ..) A single panel - UILayout.popover_group(.. panel categories ..) Expands all panels matching args. Currently used in the topbar for redo and paint options.
2018-04-22 17:16:39 +02:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int UI_popover_panel_invoke(bContext *C, const char *idname, bool keep_open, ReportList *reports);
UI: popup panel operator, as we have for menus
2018-05-23 19:46:40 +02:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Only return handler, and set optional title.
*
* \param from_active_button: Use the active button for positioning,
* use when the popover is activated from an operator instead of directly from the button.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiPopover *UI_popover_begin(bContext *C, int menu_width, bool from_active_button) ATTR_NONNULL(1);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Set the whole structure to work.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_popover_end(bContext *C, uiPopover *pup, wmKeyMap *keymap);
uiLayout *UI_popover_layout(uiPopover *pup);
UI: popover-once (click-drag for single actions) Experimental support for using popovers like menus, use this when the user hold the mouse down (previously this did nothing). This means turning frequently accessed menu items into popovers doesn't add more clicks to the existing use case.
2018-05-19 19:16:47 +02:00
void UI_popover_once_clear(uiPopover *pup);
UI: Initial popover support for panels - UILayout.popover(.. panel_type ..) A single panel - UILayout.popover_group(.. panel categories ..) Expands all panels matching args. Currently used in the topbar for redo and paint options.
2018-04-22 17:16:39 +02:00
Cleanup: correct file names in comments after C -> C++ renaming Use back-tick quotes to differentiate these from plain text.
2023-07-31 11:50:54 +10:00
/* `interface_region_menu_pie.cc` */
Cleanup: ensure space after file named in headers Add blank lines after file references to avoid them being interpreted as doc-strings the following declarations.
2022-04-04 13:17:03 +10:00
Pie Menus C code backend. This commit merges the code in the pie-menu branch. As per decisions taken the last few days, there are no pie menus included and there will be an official add-on including overrides of some keys with pie menus. However, people will now be able to use the new code in python. Full Documentation is in http://wiki.blender.org/index.php/Dev:Ref/ Thanks: Campbell Barton, Dalai Felinto and Ton Roosendaal for the code review and design comments Jonathan Williamson, Pawel Lyczkowski, Pablo Vazquez among others for suggestions during the development. Special Thanks to Sean Olson, for his support, suggestions, testing and merciless bugging so that I would finish the pie menu code. Without him we wouldn't be here. Also to the rest of the developers of the original python add-on, Patrick Moore and Dan Eicher and finally to Matt Ebb, who did the research and first implementation and whose code I used to get started.
2014-08-11 10:39:59 +02:00
/* Pie menus */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiPieMenu;
Pie Menus C code backend. This commit merges the code in the pie-menu branch. As per decisions taken the last few days, there are no pie menus included and there will be an official add-on including overrides of some keys with pie menus. However, people will now be able to use the new code in python. Full Documentation is in http://wiki.blender.org/index.php/Dev:Ref/ Thanks: Campbell Barton, Dalai Felinto and Ton Roosendaal for the code review and design comments Jonathan Williamson, Pawel Lyczkowski, Pablo Vazquez among others for suggestions during the development. Special Thanks to Sean Olson, for his support, suggestions, testing and merciless bugging so that I would finish the pie menu code. Without him we wouldn't be here. Also to the rest of the developers of the original python add-on, Patrick Moore and Dan Eicher and finally to Matt Ebb, who did the research and first implementation and whose code I used to get started.
2014-08-11 10:39:59 +02:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int UI_pie_menu_invoke(bContext *C, const char *idname, const wmEvent *event);
int UI_pie_menu_invoke_from_operator_enum(bContext *C,
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
const char *title,
const char *opname,
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const wmEvent *event);
int UI_pie_menu_invoke_from_rna_enum(bContext *C,
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
const char *title,
const char *path,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const wmEvent *event);
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiPieMenu *UI_pie_menu_begin(bContext *C, const char *title, int icon, const wmEvent *event)
ATTR_NONNULL();
void UI_pie_menu_end(bContext *C, uiPieMenu *pie);
uiLayout *UI_pie_menu_layout(uiPieMenu *pie);
Cleanup: split interface_regions.c Each region type is quite separate and file was getting too big.
2017-11-03 20:26:35 +11:00
Cleanup: correct file names in comments after C -> C++ renaming Use back-tick quotes to differentiate these from plain text.
2023-07-31 11:50:54 +10:00
/* `interface_region_menu_popup.cc` */
Cleanup: split interface_regions.c Each region type is quite separate and file was getting too big.
2017-11-03 20:26:35 +11:00
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
/* Popup Blocks
*
* Functions used to create popup blocks. These are like popup menus
* but allow using all button types and creating an own layout. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiBlockCreateFunc = uiBlock *(*)(bContext *C, ARegion *region, void *arg1);
using uiBlockCancelFunc = void (*)(bContext *C, void *arg1);
UI * Changed uiPupMenuOperator usage to uiPupMenuBegin/End (simpler, no need to build a string). Also made transform orientation and subdiv type enums instead of ints for this. * Added an icon argument to many of the uiMenu calls, and added a uiMenuItemIntO. * Move auto rna button creation out of outliner code, now is uiDefAutoButR for individual buttons and uiDefAutoButsRNA for a whole block. * Implemented uiPupBlock(O). Pressing F6 gives a menu with the properties of the last operator to test. I tried to make a redo last operator out of this but couldn't get the context correct for the operator to repeat in. Further the popup block also has some issues getting closed while editing buttons. * Fix uiAfterFunc memory leak on Ctrl+Q quit. * Fix handling of RNA number button dragging and sliding for RNA buttons with range -inf/inf.
2009-02-04 11:52:16 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_popup_block_invoke(bContext *C, uiBlockCreateFunc func, void *arg, uiFreeArgFunc arg_free);
void UI_popup_block_invoke_ex(
bContext *C, uiBlockCreateFunc func, void *arg, uiFreeArgFunc arg_free, bool can_refresh);
void UI_popup_block_ex(bContext *C,
Redraw parent popup when the child popup is closed
2017-03-30 16:48:18 +03:00
uiBlockCreateFunc func,
uiBlockHandleFunc popup_func,
uiBlockCancelFunc cancel_func,
void *arg,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperator *op);
Cleanup: comment line length (editors) Prevents clang-format wrapping text before comments.
2019-01-15 23:24:20 +11:00
#if 0 /* UNUSED */
Cleanup: format disabled code
2023-08-09 10:47:43 +10:00
void uiPupBlockOperator(bContext *C,
ClangFormat: format '#if 0' code in source/
2019-04-17 08:24:14 +02:00
uiBlockCreateFunc func,
Cleanup: format disabled code
2023-08-09 10:47:43 +10:00
wmOperator *op,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext opcontext);
Cleanup: comment line length (editors) Prevents clang-format wrapping text before comments.
2019-01-15 23:24:20 +11:00
#endif
2.5 Simple toolbox-style menu system. Brecht will review it though, and/or check on way to use it for menus. I tried to avoid uiBlock and rna stuff all over. :) Quick image test: http://www.blender.org/bf/rt.jpg Examples you can read in: - editors/screen/screen_ops.c:testing123() (press F5) - editors/object/object_edit.c:object_add_primitive_invoke() (press SHIFT+A) Concept is simple: uiMenuBegin(): returns a handle. uiMenuEnd(): puts it all to work. In between you can add items like: uiMenuItemVal(): a name, icon, retval (use uiMenuFunc()) uiMenuItemO(): an operator + icon uiMenuItemEnumO(): an operator, property name, value Sublevels go easy too: uiMenuLevel(): creates item for sublevel, with function pointer. Inside that function you can use all menu calls again. Levels can go as deep you want. uiMenuLevelEnumO(): creates operator sublevel for an enum
2009-01-25 20:22:05 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_popup_block_close(bContext *C, wmWindow *win, uiBlock *block);
Splash screen, implemented by Matt. * Now has documentation links and recent files. * Click on image or outside splash to make it go away. * Still has old image, new one will be committed later.
2009-11-23 13:58:55 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_popup_block_name_exists(const bScreen *screen, const char *name);
Fix T59946: multiple quit dialogs possible. Differential Revision: https://developer.blender.org/D4147
2019-01-04 14:23:49 +01:00
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
/* Blocks
*
* Functions for creating, drawing and freeing blocks. A Block is a
* container of buttons and used for various purposes.
Cleanup: trailing whitespace (comment blocks) Strip unindented comment blocks - mainly headers to avoid conflicts.
2018-06-01 18:19:39 +02:00
*
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
* Begin/Define Buttons/End/Draw is the typical order in which these
* function should be called, though for popup blocks Draw is left out.
* Freeing blocks is done by the screen/ module automatically.
Cleanup: remove extra in trailing asterisk Comment blocks not conforming to convention.
2021-01-20 15:15:38 +11:00
*/
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiBlock *UI_block_begin(const bContext *C,
ARegion *region,
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
const char *name,
Cleanup: Use typedef for UI emboss type enum Previously both `char` and `int` were used to represent this enum. Differential Revision: https://developer.blender.org/D9903
2020-12-19 10:07:13 -06:00
eUIEmbossType emboss);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_block_end_ex(const bContext *C, uiBlock *block, const int xy[2], int r_xy[2]);
void UI_block_end(const bContext *C, uiBlock *block);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Uses local copy of style, to scale things down, and allow widgets to change stuff.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_block_draw(const bContext *C, uiBlock *block);
void UI_blocklist_update_window_matrix(const bContext *C, const ListBase *lb);
void UI_blocklist_update_view_for_buttons(const bContext *C, const ListBase *lb);
void UI_blocklist_draw(const bContext *C, const ListBase *lb);
void UI_block_update_from_old(const bContext *C, uiBlock *block);
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
UI: split theme draw style into separate field Was using UI_BLOCK_LOOP to control draw style, this meant we couldn't use popup theme colors for cases where it the interface has the same purpose as a popup but happens not to use this flag.
2018-09-11 10:56:08 +10:00
enum {
UI_BLOCK_THEME_STYLE_REGULAR = 0,
UI_BLOCK_THEME_STYLE_POPUP = 1,
};
void UI_block_theme_style_set(uiBlock *block, char theme_style);
Cleanup: Use enum for UI block emboss type
2021-07-05 14:52:21 -05:00
eUIEmbossType UI_block_emboss_get(uiBlock *block);
Cleanup: Use typedef for UI emboss type enum Previously both `char` and `int` were used to represent this enum. Differential Revision: https://developer.blender.org/D9903
2020-12-19 10:07:13 -06:00
void UI_block_emboss_set(uiBlock *block, eUIEmbossType emboss);
UI: Single tab property search This adds a search bar to the properties editor. The full search for every tab isn't included in this patch, but the interaction with panels, searching behavior, UI, region level, and DNA changes are included here. The block-level search works by iterating over the block's button groups and checking whether they match the search. If they do, they are tagged with a flag, and the block's panel is tagged too. For every update (text edit), the panel's expansion is set to whether the panel has a result or not. The search also checks for matching strings inside enums and in panel labels. One complication to this that isn't immediately apparent is that closed panel's subpanels have to be searched too. This adds some complexity to the area-level panel layout code. Possible Future Improvements: - Use the new fuzzy search in BLI - Reset panels to their expansion before the search started if the user escape out of the text box. - Open all child panels of a panel with expansion. Differential Revision: https://developer.blender.org/D8856
2020-09-15 11:25:49 -05:00
bool UI_block_is_search_only(const uiBlock *block);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Use when a block must be searched to give accurate results
* for the whole region but shouldn't be displayed.
*/
UI: Single tab property search This adds a search bar to the properties editor. The full search for every tab isn't included in this patch, but the interaction with panels, searching behavior, UI, region level, and DNA changes are included here. The block-level search works by iterating over the block's button groups and checking whether they match the search. If they do, they are tagged with a flag, and the block's panel is tagged too. For every update (text edit), the panel's expansion is set to whether the panel has a result or not. The search also checks for matching strings inside enums and in panel labels. One complication to this that isn't immediately apparent is that closed panel's subpanels have to be searched too. This adds some complexity to the area-level panel layout code. Possible Future Improvements: - Use the new fuzzy search in BLI - Reset panels to their expansion before the search started if the user escape out of the text box. - Open all child panels of a panel with expansion. Differential Revision: https://developer.blender.org/D8856
2020-09-15 11:25:49 -05:00
void UI_block_set_search_only(uiBlock *block, bool search_only);
2.5 More cleanup! - removed old UI font completely, including from uiBeginBlock - emboss hints for uiBlock only have three types now; Regular, Pulldown, or "Nothing" (only icon/text) - removed old font path from Userdef - removed all old button theme hinting - removed old "auto block" to merge buttons in groups (was only in use for radiosity buttons) And went over all warnings. One hooray for make giving clean output :) Well, we need uniform definitions for warnings, so people at least fix them... here's the real bad bugs I found: - in mesh code, a call to editmesh mixed *em and *me - in armature, ED_util.h was not included, so no warnings for wrong call to ED_undo_push() - The extern Py api .h was not included in the bpy_interface.c, showing a several calls using different args. Further just added the missing includes, and removed unused vars.
2009-04-14 15:59:52 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Can be called with C==NULL.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_block_free(const bContext *C, uiBlock *block);
UI: Support C defined menu types to listen to notifiers Needed to dynamically load assets as menu items, see cf985180551d and 99e5024e97f1. The next commit will add the listener for the node add menu.
2022-11-01 17:36:36 +01:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_block_listen(const uiBlock *block, const wmRegionListenerParams *listener_params);
UI: Support C defined menu types to listen to notifiers Needed to dynamically load assets as menu items, see cf985180551d and 99e5024e97f1. The next commit will add the listener for the node add menu.
2022-11-01 17:36:36 +01:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Can be called with C==NULL.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_blocklist_free(const bContext *C, ARegion *region);
void UI_blocklist_free_inactive(const bContext *C, ARegion *region);
Fix T93410: Crash hiding a region from Python used by a popover Close all active buttons when hiding a region as this can be called from Python a popover is open from that region. Failure to do this causes the popover to read from the freed button. Also rename UI_screen_free_active_but to UI_screen_free_active_but_highlight since it only frees highlighted buttons.
2021-12-02 15:46:14 +11:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Is called by notifier.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_screen_free_active_but_highlight(const bContext *C, bScreen *screen);
void UI_region_free_active_but_all(bContext *context, ARegion *region);
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_block_region_set(uiBlock *block, ARegion *region);
UI: Layout Engine * Buttons are now created first, and after that the layout is computed. This means the layout engine now works at button level, and makes it easier to write templates. Otherwise you had to store all info and create the buttons later. * Added interface_templates.c as a separate file to put templates in. These can contain regular buttons, and can be put in a Free layout, which means you can specify manual coordinates, but still get nested correct inside other layouts. * API was changed to allow better nesting. Previously items were added in the last added layout specifier, i.e. one level up in the layout hierarchy. This doesn't work well in always, so now when creating things like rows or columns it always returns a layout which you have to add the items in. All py scripts were updated to follow this. * Computing the layout now goes in two passes, first estimating the required width/height of all nested layouts, and then in the second pass using the results of that to decide on the actual locations. * Enum and array buttons now follow the direction of the layout, i.e. they are vertical or horizontal depending if they are in a column or row. * Color properties now get a color picker, and only get the additional RGB sliders with Expand=True. * File/directory string properties now get a button next to them for opening the file browse, though this is not implemented yet. * Layout items can now be aligned, set align=True when creating a column, row, etc. * Buttons now get a minimum width of one icon (avoids squashing icon buttons). * Moved some more space variables into Style.
2009-05-15 11:19:59 +00:00
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_block_lock_set(uiBlock *block, bool val, const char *lockstr);
void UI_block_lock_clear(uiBlock *block);
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Asset Shelf: Transparent asset shelf header with background for buttons Draw the background of the asset shelf header fully transparent, with an opaque background with rounded corners behind sections containing buttons. This reduces the visual space consumed by the asset shelf, and makes the header follow a tabbed folder metaphor better. Also, this works much better with our click-through feature, where transparent parts of regions without buttons are passed through the region under it (we might want to consider unifying code here a bit). The edge to drag for region resizing respects the transparent sections. When there is little space between sections, the sections get merged so that there are no small gaps in the bar. Part of #107881. ---- Note that the core of this is implemented in a generic way, so this can be reused for other regions. Pull Request: https://projects.blender.org/blender/blender/pulls/112241
2023-09-26 17:12:37 +02:00
#define UI_BUTTON_SECTION_MERGE_DISTANCE (UI_UNIT_X * 3)
/* Separator line between regions if the #uiButtonSectionsAlign is not #None. */
#define UI_BUTTON_SECTION_SEPERATOR_LINE_WITH (U.pixelsize * 2)
enum class uiButtonSectionsAlign : int8_t { None = 1, Top, Bottom };
/**
* Draw a background with rounded corners behind each visual group of buttons. The visual groups
* are separated by spacer buttons (#uiItemSpacer()). Button groups that are closer than
* #UI_BUTTON_SECTION_MERGE_DISTANCE will be merged into one visual section. If the group is closer
* than that to a region edge, it will also be extended to that, and the rounded corners will be
* removed on that edge.
*
* \note This currently only works well for horizontal, header like regions.
*/
void UI_region_button_sections_draw(const ARegion *region,
int /*THemeColorID*/ colorid,
uiButtonSectionsAlign align);
bool UI_region_button_sections_is_inside_x(const ARegion *region, const int mval_x);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Automatic aligning, horizontal or vertical.
*/
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_block_align_begin(uiBlock *block);
void UI_block_align_end(uiBlock *block);
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Block bounds/position calculation. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
enum eBlockBoundsCalc {
code cleanup: use typedef'd enum for block bounds types.
2012-09-10 07:03:30 +00:00
UI_BLOCK_BOUNDS_NONE = 0,
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
UI_BLOCK_BOUNDS = 1,
Splash screen, implemented by Matt. * Now has documentation links and recent files. * Click on image or outside splash to make it go away. * Still has old image, new one will be committed later.
2009-11-23 13:58:55 +00:00
UI_BLOCK_BOUNDS_TEXT,
UI_BLOCK_BOUNDS_POPUP_MOUSE,
UI_BLOCK_BOUNDS_POPUP_MENU,
Pie Menus C code backend. This commit merges the code in the pie-menu branch. As per decisions taken the last few days, there are no pie menus included and there will be an official add-on including overrides of some keys with pie menus. However, people will now be able to use the new code in python. Full Documentation is in http://wiki.blender.org/index.php/Dev:Ref/ Thanks: Campbell Barton, Dalai Felinto and Ton Roosendaal for the code review and design comments Jonathan Williamson, Pawel Lyczkowski, Pablo Vazquez among others for suggestions during the development. Special Thanks to Sean Olson, for his support, suggestions, testing and merciless bugging so that I would finish the pie menu code. Without him we wouldn't be here. Also to the rest of the developers of the original python add-on, Patrick Moore and Dan Eicher and finally to Matt Ebb, who did the research and first implementation and whose code I used to get started.
2014-08-11 10:39:59 +02:00
UI_BLOCK_BOUNDS_POPUP_CENTER,
UI_BLOCK_BOUNDS_PIE_CENTER,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
Splash screen, implemented by Matt. * Now has documentation links and recent files. * Click on image or outside splash to make it go away. * Still has old image, new one will be committed later.
2009-11-23 13:58:55 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Used for various cases.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_block_bounds_set_normal(uiBlock *block, int addval);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Used for pull-downs.
*/
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_block_bounds_set_text(uiBlock *block, int addval);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Used for block popups.
*/
Cleanup: rename uiBlock.mx,my to bounds_offset Use a name that related to block bounds calculation (mx/my are typically used for mouse x,y).
2019-03-13 16:35:24 +11:00
void UI_block_bounds_set_popup(uiBlock *block, int addval, const int bounds_offset[2]);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Used for menu popups.
*/
Cleanup: rename uiBlock.mx,my to bounds_offset Use a name that related to block bounds calculation (mx/my are typically used for mouse x,y).
2019-03-13 16:35:24 +11:00
void UI_block_bounds_set_menu(uiBlock *block, int addval, const int bounds_offset[2]);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Used for centered popups, i.e. splash.
*/
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_block_bounds_set_centered(uiBlock *block, int addval);
void UI_block_bounds_set_explicit(uiBlock *block, int minx, int miny, int maxx, int maxy);
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int UI_blocklist_min_y_get(ListBase *lb);
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_block_direction_set(uiBlock *block, char direction);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* This call escapes if there's alignment flags.
*/
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_block_flag_enable(uiBlock *block, int flag);
void UI_block_flag_disable(uiBlock *block, int flag);
UI: fix popovers not properly working with scroll arrows for long menus.
2018-05-13 18:23:21 +02:00
void UI_block_translate(uiBlock *block, int x, int y);
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
int UI_but_return_value_get(uiBut *but);
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiBut *UI_but_active_drop_name_button(const bContext *C);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Returns true if highlighted button allows drop of names.
* called in region context.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_but_active_drop_name(const bContext *C);
bool UI_but_active_drop_color(bContext *C);
Drag and drop 2.5 integration! Finally, slashdot regulars can use Blender too now! :) ** Drag works as follows: - drag-able items are defined by the standard interface ui toolkit - each button can get this feature, via uiButSetDragXXX(but, ...). There are calls to define drag-able images, ID blocks, RNA paths, file paths, and so on. By default you drag an icon, exceptionally an ImBuf - Drag items are registered centrally in the WM, it allows more drag items simultaneous too, but not implemented ** Drop works as follows: - On mouse release, and if drag items exist in the WM, it converts the mouse event to an EVT_DROP type. This event then gets the full drag info as customdata - drop regions are defined with WM_dropbox_add(), similar to keymaps you can make a "drop map" this way, which become 'drop map handlers' in the queues. - next to that the UI kit handles some common button types (like accepting ID or names) to be catching a drop event too. - Every "drop box" has two callbacks: - poll() = check if the event drag data is relevant for this box - copy() = fill in custom properties in the dropbox to initialize an operator - The dropbox handler then calls its standard Operator with its dropbox properties. ** Currently implemented Drag items: - ID icons in browse buttons - ID icons in context menu of properties region - ID icons in outliner and rna viewer - FileBrowser icons - FileBrowser preview images Drag-able icons are subtly visualized by making them brighter a bit on mouse-over. In case the icon is a button or UI element too (most cases), the drag-able feature will make the item react to mouse-release instead of mouse-press. Drop options: - UI buttons: ID and text buttons (paste name) - View3d: Object ID drop copies object - View3d: Material ID drop assigns to object under cursor - View3d: Image ID drop assigns to object UV texture under cursor - Sequencer: Path drop will add either Image or Movie strip - Image window: Path drop will open image ** Drag and drop Notes: - Dropping into another Blender window (from same application) works too. I've added code that passes on mousemoves and clicks to other windows, without activating them though. This does make using multi-window Blender a bit friendler. - Dropping a file path to an image, is not the same as dropping an Image ID... keep this in mind. Sequencer for example wants paths to be dropped, textures in 3d window wants an Image ID. - Although drop boxes could be defined via Python, I suggest they're part of the UI and editor design (= how we want an editor to work), and not default offered configurable like keymaps. - At the moment only one item can be dragged at a time. This is for several reasons.... For one, Blender doesn't have a well defined uniform way to define "what is selected" (files, outliner items, etc). Secondly there's potential conflicts on what todo when you drop mixed drag sets on spots. All undefined stuff... nice for later. - Example to bypass the above: a collection of images that form a strip, should be represented in filewindow as a single sequence anyway. This then will fit well and gets handled neatly by design. - Another option to check is to allow multiple options per drop... it could show the operator as a sort of menu, allowing arrow or scrollwheel to choose. For time being I'd prefer to try to design a singular drop though, just offer only one drop action per data type on given spots. - What does work already, but a tad slow, is to use a function that detects an object (type) under cursor, so a drag item's option can be further refined (like drop object on object = parent). (disabled) ** More notes - Added saving for Region layouts (like split points for toolbar) - Label buttons now handle mouse over - File list: added full path entry for drop feature. - Filesel bugfix: wm_operator_exec() got called there and fully handled, while WM event code tried same. Added new OPERATOR_HANDLED flag for this. Maybe python needs it too? - Cocoa: added window move event, so multi-win setups work OK (didnt save). - Interface_handlers.c: removed win->active - Severe area copy bug: area handlers were not set to NULL - Filesel bugfix: next/prev folder list was not copied on area copies ** Leftover todos - Cocoa windows seem to hang on cases still... needs check - Cocoa 'draw overlap' swap doesn't work - Cocoa window loses focus permanently on using Spotlight (for these reasons, makefile building has Carbon as default atm) - ListView templates in UI cannot become dragged yet, needs review... it consists of two overlapping UI elements, preventing handling icon clicks. - There's already Ghost library code to handle dropping from OS into Blender window. I've noticed this code is unfinished for Macs, but seems to be complete for Windows. Needs test... currently, an external drop event will print in console when succesfully delivered to Blender's WM.
2010-01-26 18:18:21 +00:00
Revert commits to increase button flag bitfield size This reverts the commits 8d9d5da13706b668b9bd0d631e00c9b00b73f3ea, 59cd616534b46ab85b4324a0886bd9eb8876a48b and 98a04ed4524234b1840dc039c2f356db5ac57f26. The commits are causing issues with MSVC, see D14926. I'm working on a different solution, but that will need some work.
2022-05-12 15:53:12 +02:00
void UI_but_flag_enable(uiBut *but, int flag);
void UI_but_flag_disable(uiBut *but, int flag);
bool UI_but_flag_is_set(uiBut *but, int flag);
UI: support searching in menus The basic idea is very simple. Whenever a supported menu is open, one can just start typing and this opens a search that contains all the (nested) menu entries. The main downside is that this collides with accelerator keys. Those are the underlined characters in each menu. For now, we just enable this new searching behavior in a few selected menus: Node Add Menu, View3D Add Menu and Modifier Add Menu. This new functionality can be enabled for a menu by setting `bl_options = {'SEARCH_ON_KEY_PRESS'}` to true in the menu type. The status bar shows `Type to search...` when a menu is opened that supports search. Pull Request: https://projects.blender.org/blender/blender/pulls/110855
2023-09-06 18:16:45 +02:00
void UI_but_flag2_enable(uiBut *but, int flag);
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_but_drawflag_enable(uiBut *but, int flag);
void UI_but_drawflag_disable(uiBut *but, int flag);
Finish changes in up/down arrows for menus Restored single triangle for special menus, which still isn't perfect but probably makes more sense. Added drawflag bit flags to button, which is currently used to declare, that button need to have up/down arrows. This is needed because it's tricky to distinguish if button should have such arrows. For example, ID search buttons is a simple block button which doesn't directly mean it'll have pop-up menu and not all buttons which cases pop-up menu to display need to have such arrows. So currently only ID selector button is forcing up/down arrows to be displayed, all the rest buttons now behaves in the same way as it used to be before.
2012-05-23 14:24:40 +00:00
Revert release branch only commit after merge This is a revert of a revert, because the initial revert is only supposed to be in the release branch. This reverts commit 3eed00dc546b5930b255572901915ccbc26c0e69.
2023-02-20 11:51:16 +01:00
void UI_but_dragflag_enable(uiBut *but, int flag);
void UI_but_dragflag_disable(uiBut *but, int flag);
Cleanup: Add/use function to disable buttons with a disabled hint We do this in a couple of places, so it's worth having the logic wrapped into a function. Also, the only way to set the disabled hint for a button from outside of `interface/` was through `UI_block_lock_set()`/`UI_block_lock_clear()`, for which the usage isn't obvious when you just try to disable a single button.
2020-09-03 17:39:57 +02:00
void UI_but_disable(uiBut *but, const char *disabled_hint);
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_but_type_set_menu_from_pulldown(uiBut *but);
Own recent removal of string encoded menus missed render layers/passes
2014-02-12 00:08:54 +11:00
UI: Input Placeholders Optional inline hint describing the expected value of an input field. Pull Request: #112104
2023-10-12 11:44:08 -07:00
/**
* Set at hint that describes the expected value when empty.
*/
void UI_but_placeholder_set(uiBut *but, const char *placeholder_text) ATTR_NONNULL(1);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Special button case, only draw it when used actively, for outliner etc.
*
* Needed for temporarily rename buttons, such as in outliner or file-select,
* they should keep calling #uiDefBut to keep them alive.
* \return false when button removed.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_but_active_only_ex(
const bContext *C, ARegion *region, uiBlock *block, uiBut *but, bool remove_on_failure);
bool UI_but_active_only(const bContext *C, ARegion *region, uiBlock *block, uiBut *but);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \warning This must run after other handlers have been added,
Cleanup: use '#' prefix for issues instead of 'T' Match the convention from Gitea instead of Phabricator's T for tasks.
2023-02-12 14:37:16 +11:00
* otherwise the handler won't be removed, see: #71112.
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_block_active_only_flagged_buttons(const bContext *C, ARegion *region, uiBlock *block);
2.5 Outliner: brought back to near full functioning: - proper operators, like for open/close items, exec operations (note: select is still same operator as activate, should become modal ops later) - rename works again (ctrl+click) - proper notifiers for redraws - select / extend select works again - editmode in/out works again - enter key opens/closes again - right mouse operations work again Didn't do: - options for Sequence strips - signals to change button views on clicks - error/warning messages UI: - added new uiButSetRenameFunc(), which passes on the old name - added uiButActiveOnly(), which ensures a button gets created in active state, and gets removed when used. Needed for editing names in outliner. Andrea: check outliner.c for uiButActiveOnly(), very easy to use! Also: - Added posemode operator, CTRL+TAB tied to it.
2009-07-25 13:40:59 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Simulate button click.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_execute(const bContext *C, ARegion *region, uiBut *but);
Toggle-Drag UI Feature Dragging on toggle buttons can now be used to press multiple buttons at once, especially useful for layer and outliner buttons. notes: - automatically enabled for all toggle buttons (may change this if it becomes a problem). - only buttons of the same type are pressed (helps avoid annoyances eg; dragging past layer buttons onto other 3d header buttons and pressing by accident). - automatic axis locking - dragging will lock to X/Y depending on the initial drag direction, makes swipe motions work better, especially with the outliner. implementation details: - may re-implement as a region handler (currently its a modal operator). - checking buttons in-between cursor motion events could be more efficient (but currently works ok). - button execution needs to be improved (currently executing a button thats not under the mouse needed a workaround for passing uiHandleButtonData), requires further changes to UI code, will do next.
2013-02-22 05:56:20 +00:00
UI: 'View Online Manual' Shortcut D1031, implement proposal T37478 to give easy access to the online manual. Use Alt+F1 while hovering over a button/setting.
2015-04-27 01:17:51 +10:00
bool UI_but_online_manual_id(const uiBut *but,
char *r_str,
Cleanup: rename max-length to maxncpy as this includes the null byte
2023-06-10 17:21:24 +10:00
size_t str_maxncpy) ATTR_WARN_UNUSED_RESULT;
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_but_online_manual_id_from_active(const bContext *C,
UI: 'View Online Manual' Shortcut D1031, implement proposal T37478 to give easy access to the online manual. Use Alt+F1 while hovering over a button/setting.
2015-04-27 01:17:51 +10:00
char *r_str,
Cleanup: rename max-length to maxncpy as this includes the null byte
2023-06-10 17:21:24 +10:00
size_t str_maxncpy) ATTR_WARN_UNUSED_RESULT;
Fix T77171: File selector doesn't tag preferences to be saved
2020-06-11 17:24:00 +10:00
bool UI_but_is_userdef(const uiBut *but);
2.5 Outliner: brought back to near full functioning: - proper operators, like for open/close items, exec operations (note: select is still same operator as activate, should become modal ops later) - rename works again (ctrl+click) - proper notifiers for redraws - select / extend select works again - editmode in/out works again - enter key opens/closes again - right mouse operations work again Didn't do: - options for Sequence strips - signals to change button views on clicks - error/warning messages UI: - added new uiButSetRenameFunc(), which passes on the old name - added uiButActiveOnly(), which ensures a button gets created in active state, and gets removed when used. Needed for editing names in outliner. Andrea: check outliner.c for uiButActiveOnly(), very easy to use! Also: - Added posemode operator, CTRL+TAB tied to it.
2009-07-25 13:40:59 +00:00
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
/* Buttons
*
* Functions to define various types of buttons in a block. Postfixes:
* - F: float
* - I: int
* - S: short
* - C: char
* - R: RNA
* - O: operator */
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
Cleanup: right shift
2018-07-09 06:38:07 +02:00
uiBut *uiDefBut(uiBlock *block,
int type,
int retval,
const char *str,
Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes
2020-09-04 20:59:13 +02:00
int x,
int y,
short width,
short height,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
void *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
uiBut *uiDefButF(uiBlock *block,
int type,
int retval,
const char *str,
int x,
int y,
short width,
short height,
float *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefButI(uiBlock *block,
int type,
int retval,
const char *str,
int x,
int y,
short width,
short height,
int *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefButBitI(uiBlock *block,
int type,
int bit,
int retval,
const char *str,
int x,
int y,
short width,
short height,
int *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefButS(uiBlock *block,
int type,
int retval,
const char *str,
int x,
int y,
short width,
short height,
short *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefButBitS(uiBlock *block,
int type,
int bit,
int retval,
const char *str,
int x,
int y,
short width,
short height,
short *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefButC(uiBlock *block,
int type,
int retval,
const char *str,
int x,
int y,
short width,
short height,
char *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefButBitC(uiBlock *block,
int type,
int bit,
int retval,
const char *str,
int x,
int y,
short width,
short height,
char *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefButR(uiBlock *block,
int type,
int retval,
const char *str,
int x,
int y,
short width,
short height,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
const char *propname,
int index,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefButR_prop(uiBlock *block,
int type,
int retval,
const char *str,
int x,
int y,
short width,
short height,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
PropertyRNA *prop,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
int index,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefButO(uiBlock *block,
int type,
const char *opname,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext opcontext,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
const char *str,
int x,
int y,
short width,
short height,
const char *tip);
uiBut *uiDefButO_ptr(uiBlock *block,
int type,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperatorType *ot,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext opcontext,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
const char *str,
int x,
int y,
short width,
short height,
const char *tip);
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* If a1==1.0 then a2 is an extra icon blending factor (alpha 0.0 - 1.0).
*/
Cleanup: right shift
2018-07-09 06:38:07 +02:00
uiBut *uiDefIconBut(uiBlock *block,
int type,
int retval,
int icon,
Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes
2020-09-04 20:59:13 +02:00
int x,
int y,
short width,
short height,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
void *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
uiBut *uiDefIconButI(uiBlock *block,
int type,
int retval,
int icon,
int x,
int y,
short width,
short height,
int *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconButBitI(uiBlock *block,
int type,
int bit,
int retval,
int icon,
int x,
int y,
short width,
short height,
int *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconButS(uiBlock *block,
int type,
int retval,
int icon,
int x,
int y,
short width,
short height,
short *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconButBitS(uiBlock *block,
int type,
int bit,
int retval,
int icon,
int x,
int y,
short width,
short height,
short *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconButBitC(uiBlock *block,
int type,
int bit,
int retval,
int icon,
int x,
int y,
short width,
short height,
char *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconButR(uiBlock *block,
int type,
int retval,
int icon,
int x,
int y,
short width,
short height,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
const char *propname,
int index,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconButR_prop(uiBlock *block,
int type,
int retval,
int icon,
int x,
int y,
short width,
short height,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
PropertyRNA *prop,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
int index,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconButO(uiBlock *block,
int type,
const char *opname,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext opcontext,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
int icon,
int x,
int y,
short width,
short height,
const char *tip);
uiBut *uiDefIconButO_ptr(uiBlock *block,
int type,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperatorType *ot,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext opcontext,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
int icon,
int x,
int y,
short width,
short height,
const char *tip);
UI: Larger Alert Icons Adding a set of larger icons for use in informational dialogs. Differential Revision: https://developer.blender.org/D6859 Reviewed by Campbell Barton
2020-03-14 11:05:09 -07:00
uiBut *uiDefButImage(
uiBlock *block, void *imbuf, int x, int y, short width, short height, const uchar color[4]);
Cleanup: shadow warning, clang-format
2020-03-15 17:32:06 +11:00
uiBut *uiDefButAlert(uiBlock *block, int icon, int x, int y, short width, short height);
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Button containing both string label and icon. */
Cleanup: right shift
2018-07-09 06:38:07 +02:00
uiBut *uiDefIconTextBut(uiBlock *block,
int type,
int retval,
int icon,
const char *str,
Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes
2020-09-04 20:59:13 +02:00
int x,
int y,
short width,
short height,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
void *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
uiBut *uiDefIconTextButF(uiBlock *block,
int type,
int retval,
int icon,
const char *str,
int x,
int y,
short width,
short height,
float *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconTextButI(uiBlock *block,
int type,
int retval,
int icon,
const char *str,
int x,
int y,
short width,
short height,
int *poin,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconTextButR(uiBlock *block,
int type,
int retval,
int icon,
const char *str,
int x,
int y,
short width,
short height,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
const char *propname,
int index,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconTextButR_prop(uiBlock *block,
int type,
int retval,
int icon,
const char *str,
int x,
int y,
short width,
short height,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
PropertyRNA *prop,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
int index,
float min,
float max,
float a1,
float a2,
const char *tip);
uiBut *uiDefIconTextButO(uiBlock *block,
int type,
const char *opname,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext opcontext,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
int icon,
const char *str,
int x,
int y,
short width,
short height,
const char *tip);
uiBut *uiDefIconTextButO_ptr(uiBlock *block,
int type,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperatorType *ot,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext opcontext,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
int icon,
const char *str,
int x,
int y,
short width,
short height,
const char *tip);
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** For passing inputs to ButO buttons. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *UI_but_operator_ptr_get(uiBut *but);
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_context_ptr_set(uiBlock *block, uiBut *but, const char *name, const PointerRNA *ptr);
const PointerRNA *UI_but_context_ptr_get(const uiBut *but,
const char *name,
const StructRNA *type CPP_ARG_DEFAULT(nullptr));
Cleanup: Use const for context store variables Generally the context store is owned by `uiBlock`. Other pointers to the store (in `bContext` and other operator data) shouldn't change it, so those variables are now const. One exception is the pointer in `uiLayout`, but that has a clearly short lifetime, so that's okay.
2023-08-31 11:59:58 -04:00
const bContextStore *UI_but_context_get(const uiBut *but);
Drag & drop: Support using context of hovered button when dropping Buttons can hold context and it's very useful to use this as a way to let buttons provide context for drop operators. For example, with this D13549 can make the material slot list set the material-slot pointer for each row, and the drop operator can just query that.
2022-01-28 16:42:23 +01:00
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
void UI_but_unit_type_set(uiBut *but, int unit_type);
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
int UI_but_unit_type_get(const uiBut *but);
bugfix [#25154] .MXF files should be included as a known video file type in the sequencer [#25159] Vertex locations dont read correctly and are not labeled correctly in the properties bar. - non rna buttons can now have units set. - calls with invalid units system now raises an assert(). - include .mxf in filter.
2010-12-10 04:10:21 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
enum uiStringInfoType {
UI translation from inside Blender UI: first part. This commit reshapes a bit runtime button info getter, by adding a new uiButGetStrInfo() which accepts a variable number of uiStringInfo parameters, and tries to fill them with the requested strings, for the given button (label, tip, context, RNA identifier, keymap, etc.). Currently used mostly by existing ui_tooltip_create(), and new UI_OT_edittranslation_init operator. It also adds a few getters (to get RNA i18n context, and current language iso code). Finally, it adds to C operators needed for the py ui_translation addon: *UI_OT_edittranslation_init, which gathers requested data and launch the py operator. *UI_OT_reloadtranslation, which forces a full reload of the whole UI translation (including rechecking the directory containing mo files). For the first operator to work, it also adds a new user preferences path: i18n_branches_directory, to point to the /branch part of a bf-translation checkout.
2012-07-09 14:25:35 +00:00
BUT_GET_RNAPROP_IDENTIFIER = 1,
BUT_GET_RNASTRUCT_IDENTIFIER,
BUT_GET_RNAENUM_IDENTIFIER,
BUT_GET_LABEL,
Fix tooltip showing button label redundantly (regression) With 9d0907560a, button tooltips would now often display the label even though it's already visible in the button itself. This fix brings back the old logic for displaying the label, but it's still possible to override the label via the callback introduced in the earlier commit. Comments are updated/added here to make the behavior more clear. Pull Request: https://projects.blender.org/blender/blender/pulls/110469
2023-09-21 14:49:53 +02:00
/** Query the result of #uiBut::tip_label_func(). Meant to allow overriding the label to be
* displayed in the tooltip. */
UI: Refactor quick label tooltip implementation for buttons No user visible changes expected. Used in the asset shelf branch, see #104831. These tooltips only show a label string and appear after a shorter timeout than the regular tooltips. After the regular tooltip timeout they expand to the full tooltip. The toolbar and properties editor navigation tabs make use of this already. The changes here enable more control over quick label tooltips, making them usable in more cases, and less ad-hoc. Main changes: - Refactors internal logic so a single `UI_BUT_HAS_TOOLTIP_LABEL` button flag can be used to enable quick label tooltips. This decentralizes logic in a way that's more consistent and extensible. - Custom callback to return a quick label. This is useful when a label tooltip should be displayed even when there is no button string set. E.g. in the asset shelf with "Show Names" disabled. Pull Request: https://projects.blender.org/blender/blender/pulls/110200
2023-07-25 16:22:31 +02:00
BUT_GET_TIP_LABEL,
UI translation from inside Blender UI: first part. This commit reshapes a bit runtime button info getter, by adding a new uiButGetStrInfo() which accepts a variable number of uiStringInfo parameters, and tries to fill them with the requested strings, for the given button (label, tip, context, RNA identifier, keymap, etc.). Currently used mostly by existing ui_tooltip_create(), and new UI_OT_edittranslation_init operator. It also adds a few getters (to get RNA i18n context, and current language iso code). Finally, it adds to C operators needed for the py ui_translation addon: *UI_OT_edittranslation_init, which gathers requested data and launch the py operator. *UI_OT_reloadtranslation, which forces a full reload of the whole UI translation (including rechecking the directory containing mo files). For the first operator to work, it also adds a new user preferences path: i18n_branches_directory, to point to the /branch part of a bf-translation checkout.
2012-07-09 14:25:35 +00:00
BUT_GET_RNA_LABEL,
BUT_GET_RNAENUM_LABEL,
BUT_GET_RNA_LABEL_CONTEXT, /* Context specified in CTX_XXX_ macros are just unreachable! */
BUT_GET_TIP,
BUT_GET_RNA_TIP,
BUT_GET_RNAENUM_TIP,
Bugfix [35841] WM_OT_context_[toggle/cycle/etc.] operators dont show shortcut keys in menus (or tooltips) for properties they are used to toggle/cycle through Some properties can be toggled using hotkeys via WM_OT_context_* operators, but these hotkeys aren't really shown anywhere obvious like other hotkeys (i.e. they're not shown in tooltips or menus). Although it is possible to look these up in the userprefs/keymaps editor, it is quite tricky doing so, and most users would just assume that since no shortcut is displayed, there simply isn't one at all. This commit introduces a slightly hacky fix which basically amounts to checking if a property can be set by any of the few operators which are used for this purpose. In order to keep this from being too sluggish, I've currently limited this to only working on Editor (e.g. "Show Seconds" in Anim Editors) and ToolSettings (e.g. "Use Proportional Edit") properties. There are still some corner cases that would be nice to solve too (i.e. the Pivot Type enum menu/dropdown should really be able to show the hotkeys which have been assigned for each of those items, since they're by-and-large quite hidden and obscure), though being able to show some of these is perhaps better than not showing any!
2013-07-07 12:53:15 +00:00
BUT_GET_OP_KEYMAP,
Cleanup: trailing commas Needed for clan-format not to wrap onto one line.
2019-02-03 14:01:45 +11:00
BUT_GET_PROP_KEYMAP,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
UI translation from inside Blender UI: first part. This commit reshapes a bit runtime button info getter, by adding a new uiButGetStrInfo() which accepts a variable number of uiStringInfo parameters, and tries to fill them with the requested strings, for the given button (label, tip, context, RNA identifier, keymap, etc.). Currently used mostly by existing ui_tooltip_create(), and new UI_OT_edittranslation_init operator. It also adds a few getters (to get RNA i18n context, and current language iso code). Finally, it adds to C operators needed for the py ui_translation addon: *UI_OT_edittranslation_init, which gathers requested data and launch the py operator. *UI_OT_reloadtranslation, which forces a full reload of the whole UI translation (including rechecking the directory containing mo files). For the first operator to work, it also adds a new user preferences path: i18n_branches_directory, to point to the /branch part of a bf-translation checkout.
2012-07-09 14:25:35 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiStringInfo {
Cleanup: Use typedef for button string info type Before, it wasn't clear what the int in `uiStringInfo` was supposed to store. Using a typedef can make this someone more explicit.
2020-12-04 08:01:54 -06:00
uiStringInfoType type;
UI translation from inside Blender UI: first part. This commit reshapes a bit runtime button info getter, by adding a new uiButGetStrInfo() which accepts a variable number of uiStringInfo parameters, and tries to fill them with the requested strings, for the given button (label, tip, context, RNA identifier, keymap, etc.). Currently used mostly by existing ui_tooltip_create(), and new UI_OT_edittranslation_init operator. It also adds a few getters (to get RNA i18n context, and current language iso code). Finally, it adds to C operators needed for the py ui_translation addon: *UI_OT_edittranslation_init, which gathers requested data and launch the py operator. *UI_OT_reloadtranslation, which forces a full reload of the whole UI translation (including rechecking the directory containing mo files). For the first operator to work, it also adds a new user preferences path: i18n_branches_directory, to point to the /branch part of a bf-translation checkout.
2012-07-09 14:25:35 +00:00
char *strinfo;
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
UI translation from inside Blender UI: first part. This commit reshapes a bit runtime button info getter, by adding a new uiButGetStrInfo() which accepts a variable number of uiStringInfo parameters, and tries to fill them with the requested strings, for the given button (label, tip, context, RNA identifier, keymap, etc.). Currently used mostly by existing ui_tooltip_create(), and new UI_OT_edittranslation_init operator. It also adds a few getters (to get RNA i18n context, and current language iso code). Finally, it adds to C operators needed for the py ui_translation addon: *UI_OT_edittranslation_init, which gathers requested data and launch the py operator. *UI_OT_reloadtranslation, which forces a full reload of the whole UI translation (including rechecking the directory containing mo files). For the first operator to work, it also adds a new user preferences path: i18n_branches_directory, to point to the /branch part of a bf-translation checkout.
2012-07-09 14:25:35 +00:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/**
* \note Expects pointers to #uiStringInfo structs as parameters.
* Will fill them with translated strings, when possible.
* Strings in #uiStringInfo must be MEM_freeN'ed by caller.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_string_info_get(bContext *C, uiBut *but, ...) ATTR_SENTINEL(0);
void UI_but_extra_icon_string_info_get(bContext *C, uiButExtraOpIcon *extra_icon, ...)
UI: Support tooltips for superimposed icons In a couple of places in the UI, we show superimposed icons on buttons to execute an operation (called "Extra Icons" internally). Hovering them would show the tooltip of the underlying button, which is misleading and confusing. There are cases where it's not obvious what an icon does, so a tooltip would be quite useful here. It's likely we are going to use superimposed icons in more places in the future, e.g. see D11890. The extra icon basically acts as an override for the button in the tooltip code. Differential Revision: https://developer.blender.org/D11894 Reviewed by: Campbell Barton
2021-10-08 14:17:03 +02:00
ATTR_SENTINEL(0);
UI translation from inside Blender UI: first part. This commit reshapes a bit runtime button info getter, by adding a new uiButGetStrInfo() which accepts a variable number of uiStringInfo parameters, and tries to fill them with the requested strings, for the given button (label, tip, context, RNA identifier, keymap, etc.). Currently used mostly by existing ui_tooltip_create(), and new UI_OT_edittranslation_init operator. It also adds a few getters (to get RNA i18n context, and current language iso code). Finally, it adds to C operators needed for the py ui_translation addon: *UI_OT_edittranslation_init, which gathers requested data and launch the py operator. *UI_OT_reloadtranslation, which forces a full reload of the whole UI translation (including rechecking the directory containing mo files). For the first operator to work, it also adds a new user preferences path: i18n_branches_directory, to point to the /branch part of a bf-translation checkout.
2012-07-09 14:25:35 +00:00
/* Edit i18n stuff. */
/* Name of the main py op from i18n addon. */
#define EDTSRC_I18N_OP_NAME "UI_OT_edittranslation"
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
/**
* Special Buttons
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
*
Spelling Cleanup
2012-03-01 12:20:18 +00:00
* Buttons with a more specific purpose:
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
* - MenuBut: buttons that popup a menu (in headers usually).
* - PulldownBut: like MenuBut, but creating a uiBlock (for compatibility).
* - BlockBut: buttons that popup a block with more buttons.
* - KeyevtBut: buttons that can be used to turn key events into values.
UI * Changed uiPupMenuOperator usage to uiPupMenuBegin/End (simpler, no need to build a string). Also made transform orientation and subdiv type enums instead of ints for this. * Added an icon argument to many of the uiMenu calls, and added a uiMenuItemIntO. * Move auto rna button creation out of outliner code, now is uiDefAutoButR for individual buttons and uiDefAutoButsRNA for a whole block. * Implemented uiPupBlock(O). Pressing F6 gives a menu with the properties of the last operator to test. I tried to make a redo last operator out of this but couldn't get the context correct for the operator to repeat in. Further the popup block also has some issues getting closed while editing buttons. * Fix uiAfterFunc memory leak on Ctrl+Q quit. * Fix handling of RNA number button dragging and sliding for RNA buttons with range -inf/inf.
2009-02-04 11:52:16 +00:00
* - PickerButtons: buttons like the color picker (for code sharing).
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
* - AutoButR: RNA property button with type automatically defined.
*/
enum {
Fix T101510: Incorrect context for running data unlink from template ID There was already a fix for this, but it got broken again with c973d333da31.
2022-10-03 18:13:57 +02:00
UI_ID_NOP = 0,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_ID_RENAME = 1 << 0,
UI_ID_BROWSE = 1 << 1,
UI_ID_ADD_NEW = 1 << 2,
UI_ID_ALONE = 1 << 4,
UI_ID_OPEN = 1 << 3,
UI_ID_DELETE = 1 << 5,
UI: Revert design changes to data-block selector for the 2.92 release Partially reverts 2250b5cefee7. Removing the user count and fake user count icons was controversial (which was expected) and there are a few further changes needed, that won't make it in time for the release, see D9946. While there is a design to bring back the user count and fake user indicators, a new design idea was proposed that the UI team wants to follow. This came too late for the 2.92 release, the new design is targeted at the 2.93 release now. Meanwhile, UI team decision was to simply revert the design changes. The new design is being worked on in https://developer.blender.org/T84669. Note that this commit does not revert some internal changes done in 2250b5cefee7. Namely the introduction of `ed_util_ops.c` and data-block operators in there. These will still be needed in the new design.
2021-01-13 15:08:09 +01:00
UI_ID_LOCAL = 1 << 6,
UI_ID_AUTO_NAME = 1 << 7,
UI_ID_FAKE_USER = 1 << 8,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_ID_PIN = 1 << 9,
UI_ID_PREVIEWS = 1 << 10,
UI: Revert design changes to data-block selector for the 2.92 release Partially reverts 2250b5cefee7. Removing the user count and fake user count icons was controversial (which was expected) and there are a few further changes needed, that won't make it in time for the release, see D9946. While there is a design to bring back the user count and fake user indicators, a new design idea was proposed that the UI team wants to follow. This came too late for the 2.92 release, the new design is targeted at the 2.93 release now. Meanwhile, UI team decision was to simply revert the design changes. The new design is being worked on in https://developer.blender.org/T84669. Note that this commit does not revert some internal changes done in 2250b5cefee7. Namely the introduction of `ed_util_ops.c` and data-block operators in there. These will still be needed in the new design.
2021-01-13 15:08:09 +01:00
UI_ID_OVERRIDE = 1 << 11,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_ID_FULL = UI_ID_RENAME | UI_ID_BROWSE | UI_ID_ADD_NEW | UI_ID_OPEN | UI_ID_ALONE |
UI: Revert design changes to data-block selector for the 2.92 release Partially reverts 2250b5cefee7. Removing the user count and fake user count icons was controversial (which was expected) and there are a few further changes needed, that won't make it in time for the release, see D9946. While there is a design to bring back the user count and fake user indicators, a new design idea was proposed that the UI team wants to follow. This came too late for the 2.92 release, the new design is targeted at the 2.93 release now. Meanwhile, UI team decision was to simply revert the design changes. The new design is being worked on in https://developer.blender.org/T84669. Note that this commit does not revert some internal changes done in 2250b5cefee7. Namely the introduction of `ed_util_ops.c` and data-block operators in there. These will still be needed in the new design.
2021-01-13 15:08:09 +01:00
UI_ID_DELETE | UI_ID_LOCAL,
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
};
2.5: ID datablock button back, previously known as std_libbuttons. The way this worked in 2.4x wasn't really clean, with events going all over the place and using dubious variables such as G.but->lockpoin or G.sima->menunr. It works as follows now, for example: xco= uiDefIDPoinButs(block, CTX_data_main(C), NULL, (ID**)&sima->image, ID_IM, &sima->pin, xco, yco, sima_idpoin_handle, UI_ID_BROWSE|UI_ID_RENAME|UI_ID_ADD_NEW|UI_ID_OPEN|UI_ID_DELETE|UI_ID_ALONE|UI_ID_PIN); The last two parameters are a callback function, and a list of events or functionalities that are supported. The callback function will then get the ID pointer + event to handle.
2009-02-06 16:40:14 +00:00
Fix T53632: Objects outside scene shown in popup Only show objects in current scene when not pinned. This commit adds a filter argument to id-template since we may want to filter by other criteria.
2018-01-03 21:54:02 +11:00
/**
* Ways to limit what is displayed in ID-search popup.
* \note We may want to add LOCAL, LIBRARY ... as needed.
*/
enum {
UI_TEMPLATE_ID_FILTER_ALL = 0,
UI_TEMPLATE_ID_FILTER_AVAILABLE = 1,
};
UI: add progress indicator variations & RNA API Add pie and ring styles of progress indicators. Exposes progress bar to the Python API and adds a "type" property to allow style variation. This can be used for scripts & add-ons to show progress in the UI. Ref !109882. Co-authored-by: Campbell Barton <campbell@blender.org>
2023-07-12 13:18:06 +10:00
enum eButProgressType {
UI_BUT_PROGRESS_TYPE_BAR = 0,
UI_BUT_PROGRESS_TYPE_RING = 1,
};
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/***************************** ID Utilities *******************************/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int UI_icon_from_id(const ID *id);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/** See: #BKE_report_type_str */
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
int UI_icon_from_report_type(int type);
Fix for T84038: Improved Report Warnings Improved contrast for Status Bar report warning messages. Differential Revision: https://developer.blender.org/D10242 Reviewed by Hans Goudey
2021-02-08 08:19:23 -08:00
int UI_icon_colorid_from_report_type(int type);
int UI_text_colorid_from_report_type(int type);
Object mode Selection options brought back for view3d.select - 'center', while Ctrl is held select objects from their center location - 'enumerate', while Alt is held, give a list of objects under the mouse - Object selection menu now uses icons with names - operator object.select_name(name, extend=False) - keybindings so combinations of Ctrl/Alt/Shift can be used (like in 2.4x) - logic text input field was using deprecated ID_SCRIPT rather then ID_TXT details - added comments to DNA_ID.h ID types - removed unused ID types Sector and Life - added uiIconFromID() to get an icon from the object. - using name for selection is weak but currently there isnt a really good way to do this.
2009-09-16 01:15:30 +00:00
Icons: support for drawing event icons Use for drawing modal operator header keys.
2018-07-08 11:57:59 +02:00
int UI_icon_from_event_type(short event_type, short event_value);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int UI_icon_from_keymap_item(const wmKeyMapItem *kmi, int r_icon_mod[4]);
Icons: support for drawing event icons Use for drawing modal operator header keys.
2018-07-08 11:57:59 +02:00
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
uiBut *uiDefPulldownBut(uiBlock *block,
uiBlockCreateFunc func,
void *arg,
const char *str,
int x,
int y,
short width,
short height,
const char *tip);
uiBut *uiDefMenuBut(uiBlock *block,
uiMenuCreateFunc func,
void *arg,
const char *str,
int x,
int y,
short width,
short height,
const char *tip);
uiBut *uiDefIconTextMenuBut(uiBlock *block,
uiMenuCreateFunc func,
void *arg,
int icon,
const char *str,
int x,
int y,
short width,
short height,
const char *tip);
uiBut *uiDefIconMenuBut(uiBlock *block,
uiMenuCreateFunc func,
void *arg,
int icon,
int x,
int y,
short width,
short height,
const char *tip);
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
uiBut *uiDefBlockBut(uiBlock *block,
uiBlockCreateFunc func,
Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes
2020-09-04 20:59:13 +02:00
void *arg,
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
const char *str,
int x,
int y,
short width,
short height,
const char *tip);
uiBut *uiDefBlockButN(uiBlock *block,
uiBlockCreateFunc func,
void *argN,
const char *str,
int x,
int y,
short width,
short height,
const char *tip);
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Block button containing icon.
*/
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
uiBut *uiDefIconBlockBut(uiBlock *block,
uiBlockCreateFunc func,
void *arg,
int retval,
int icon,
int x,
int y,
short width,
short height,
const char *tip);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Block button containing both string label and icon.
*/
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
uiBut *uiDefIconTextBlockBut(uiBlock *block,
uiBlockCreateFunc func,
void *arg,
int icon,
const char *str,
int x,
int y,
short width,
short height,
const char *tip);
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
Cleanup: correct unbalanced doxygen groups Also add groups in some files.
2021-12-14 15:49:31 +11:00
* \param arg: A pointer to string/name, use #UI_but_func_search_set() below to make this work.
* here `a1` and `a2`, if set, control thumbnail preview rows/cols.
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
code cleanup: use BLI rect functions for interface button and block code.
2012-08-18 18:11:51 +00:00
uiBut *uiDefSearchBut(uiBlock *block,
void *arg,
int retval,
int icon,
int maxlen,
int x,
int y,
short width,
short height,
float a1,
float a2,
WM: drag and drop poll functions can now specify a custom tooltip.
2018-08-07 10:38:20 +02:00
const char *tip);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Same parameters as for #uiDefSearchBut, with additional operator type and properties,
* used by callback to call again the right op with the right options (properties values).
*/
Cleanup: right shift
2018-07-09 06:38:07 +02:00
uiBut *uiDefSearchButO_ptr(uiBlock *block,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperatorType *ot,
IDProperty *properties,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
void *arg,
int retval,
int icon,
int maxlen,
int x,
int y,
short width,
short height,
float a1,
float a2,
const char *tip);
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** For #uiDefAutoButsRNA. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
enum eButLabelAlign {
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Keep current layout for aligning label with property button. */
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
UI_BUT_LABEL_ALIGN_NONE,
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Align label and property button vertically. */
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
UI_BUT_LABEL_ALIGN_COLUMN,
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Split layout into a column for the label and one for property button. */
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
UI_BUT_LABEL_ALIGN_SPLIT_COLUMN,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Return info for uiDefAutoButsRNA. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
enum eAutoPropButsReturn {
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Returns when no buttons were added */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_PROP_BUTS_NONE_ADDED = 1 << 0,
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Returned when any property failed the custom check callback (check_prop) */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_PROP_BUTS_ANY_FAILED_CHECK = 1 << 1,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
Cleanup: Remove interface region files to C++ Moves all `interface_region*` files to C++ except for the tooptip region which is slightly more complicated. Also move a few other files as well. This helps to simplify and speed up code, especially through the use of better C++ data structures. This change builds on all platforms on the buildbot.
2022-04-02 16:17:48 -05:00
ENUM_OPERATORS(eAutoPropButsReturn, UI_PROP_BUTS_ANY_FAILED_CHECK);
Enabled GCC -Wwrite-strings warning for CMake and replaced many 'char's for 'const char's,. Only one functional change where Transform orientations passed "" to BIF_createTransformOrientation() which could then have the value written into.
2010-12-03 17:05:21 +00:00
uiBut *uiDefAutoButR(uiBlock *block,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
PropertyRNA *prop,
Enabled GCC -Wwrite-strings warning for CMake and replaced many 'char's for 'const char's,. Only one functional change where Transform orientations passed "" to BIF_createTransformOrientation() which could then have the value written into.
2010-12-03 17:05:21 +00:00
int index,
const char *name,
int icon,
Cleanup: rename x1/x2/y1/y2 to x/y/width/height
2021-03-19 20:22:37 +01:00
int x,
int y,
int width,
int height);
Outliner: Display buttons to edit library override properties As proposed in T95802, this adds buttons to a new column on the right to modify the override in the Library Override display mode. Some further usability improvements are planned. E.g. this does not yet expand collections (modifiers, constraints, etc) nicely or group modified properties of a modifier together. Vector properties with more than 3 items or matrices aren't displayed nicely yet, they are just squeezed into the column. If this actually becomes a problem there are some ideas to address this. Differential Revision: https://developer.blender.org/D14268
2022-03-15 18:43:26 +01:00
void uiDefAutoButsArrayR(uiBlock *block,
PointerRNA *ptr,
PropertyRNA *prop,
const int icon,
const int x,
const int y,
const int tot_width,
const int height);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \a check_prop callback filters functions to avoid drawing certain properties,
* in cases where PROP_HIDDEN flag can't be used for a property.
*
* \param prop_activate_init: Property to activate on initial popup (#UI_BUT_ACTIVATE_ON_INIT).
*/
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
eAutoPropButsReturn uiDefAutoButsRNA(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
bool (*check_prop)(PointerRNA *ptr,
PropertyRNA *prop,
WM: Add operator property poll callback This allows operators to filter out properties from the auto-generated draw functions. Some custom draw functions can move to using this.
2018-07-26 09:59:56 +10:00
void *user_data),
void *user_data,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PropertyRNA *prop_activate_init,
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
eButLabelAlign label_align,
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
bool compact);
UI * Changed uiPupMenuOperator usage to uiPupMenuBegin/End (simpler, no need to build a string). Also made transform orientation and subdiv type enums instead of ints for this. * Added an icon argument to many of the uiMenu calls, and added a uiMenuItemIntO. * Move auto rna button creation out of outliner code, now is uiDefAutoButR for individual buttons and uiDefAutoButsRNA for a whole block. * Implemented uiPupBlock(O). Pressing F6 gives a menu with the properties of the last operator to test. I tried to make a redo last operator out of this but couldn't get the context correct for the operator to repeat in. Further the popup block also has some issues getting closed while editing buttons. * Fix uiAfterFunc memory leak on Ctrl+Q quit. * Fix handling of RNA number button dragging and sliding for RNA buttons with range -inf/inf.
2009-02-04 11:52:16 +00:00
UI: Add callback for comparing button identity The code to compare buttons from the previous to the current frame, to see if they match (an thus should keep the same state) was quite generic, and didn't allow much flexibility/customization. For some cases this isn't enough, and a more specific comparison is needed. Say if some buttons don't actually store comparable data themselves, only via the button context. This was the case in D14653.
2022-04-26 22:26:15 +02:00
/**
* Callback to compare the identity of two buttons, used to identify buttons over redraws. If the
* callback returns true, the given buttons are considered to be matching and relevant state is
* preserved (copied from the old to the new button). If it returns false, it's considered
* non-matching and no further checks are done.
*
* If this is set, it is always executed instead of the default comparisons. However it is only
* executed for buttons that have the same type and the same callback. So callbacks can assume the
* button types match.
*/
void UI_but_func_identity_compare_set(uiBut *but, uiButIdentityCompareFunc cmp_fn);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Public function exported for functions that use #UI_BTYPE_SEARCH_MENU.
*
* Use inside searchfunc to add items.
*
* \param items: Stores the items.
* \param name: Text to display for the item.
* \param poin: Opaque pointer (for use by the caller).
* \param iconid: The icon, #ICON_NONE for no icon.
UI Code Quality: Resolve frankenstein bit-flag usage for widget drawing Previously we would pass button state and draw information to widget draw callbacks in a rather hacky way. Some specific flags from `uiBut.flag` were masked out, so their bits could be reused for also passing `uiBut.drawflag` in the same int. Instead this commit introduces a state-info struct that can properly hold all the relevant data. This has the advantage that it's now easier to introduce new state data that needs to be accessible in the widget callbacks. Since we are running out of button flags, we plan to reorganize button flags, and split them up into multiple bitfields. In the widget drawing code, this would have been a hassle earlier. Also had to add a new widget callback to draw blocks as widgets (popup backgrounds), since that would pass block flags where we would usually pass button flags. This wasn't nice, now it's separated more clearly.
2022-05-21 00:29:32 +02:00
* \param but_flag: Button flags (#uiBut.flag) indicating the state of the item, typically
Cleanup: Correct misleading comment in UI code
2022-05-24 11:30:46 +02:00
* #UI_BUT_DISABLED, #UI_BUT_INACTIVE or #UI_BUT_HAS_SEP_CHAR.
UI Code Quality: Resolve frankenstein bit-flag usage for widget drawing Previously we would pass button state and draw information to widget draw callbacks in a rather hacky way. Some specific flags from `uiBut.flag` were masked out, so their bits could be reused for also passing `uiBut.drawflag` in the same int. Instead this commit introduces a state-info struct that can properly hold all the relevant data. This has the advantage that it's now easier to introduce new state data that needs to be accessible in the widget callbacks. Since we are running out of button flags, we plan to reorganize button flags, and split them up into multiple bitfields. In the widget drawing code, this would have been a hassle earlier. Also had to add a new widget callback to draw blocks as widgets (popup backgrounds), since that would pass block flags where we would usually pass button flags. This wasn't nice, now it's separated more clearly.
2022-05-21 00:29:32 +02:00
*
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
* \return false if there is nothing to add.
*/
Fix T79162: 'prop_search' includes ID prefix in string properties Regression from d6cefef98f87a This also fixes an unreported issue where finding an exact match wasn't being detected for items that contained an ID prefix.
2020-07-23 17:24:17 +10:00
bool UI_search_item_add(uiSearchItems *items,
const char *name,
void *poin,
int iconid,
UI Code Quality: Resolve frankenstein bit-flag usage for widget drawing Previously we would pass button state and draw information to widget draw callbacks in a rather hacky way. Some specific flags from `uiBut.flag` were masked out, so their bits could be reused for also passing `uiBut.drawflag` in the same int. Instead this commit introduces a state-info struct that can properly hold all the relevant data. This has the advantage that it's now easier to introduce new state data that needs to be accessible in the widget callbacks. Since we are running out of button flags, we plan to reorganize button flags, and split them up into multiple bitfields. In the widget drawing code, this would have been a hassle earlier. Also had to add a new widget callback to draw blocks as widgets (popup backgrounds), since that would pass block flags where we would usually pass button flags. This wasn't nice, now it's separated more clearly.
2022-05-21 00:29:32 +02:00
int but_flag,
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
uint8_t name_prefix_offset);
Fix T79162: 'prop_search' includes ID prefix in string properties Regression from d6cefef98f87a This also fixes an unreported issue where finding an exact match wasn't being detected for items that contained an ID prefix.
2020-07-23 17:24:17 +10:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \note The item-pointer (referred to below) is a per search item user pointer
* passed to #UI_search_item_add (stored in #uiSearchItems.pointers).
*
* \param search_create_fn: Function to create the menu.
* \param search_update_fn: Function to refresh search content after the search text has changed.
* \param arg: user value.
* \param free_arg: Set to true if the argument is newly allocated memory for every redraw and
* should be freed when the button is destroyed.
* \param search_arg_free_fn: When non-null, use this function to free \a arg.
* \param search_exec_fn: Function that executes the action, gets \a arg as the first argument.
* The second argument as the active item-pointer
* \param active: When non-null, this item-pointer item will be visible and selected,
* otherwise the first item will be selected.
*/
UI: Add search-create callback Needed to support alternate search UI's, no functional changes.
2016-03-02 13:57:16 +11:00
void UI_but_func_search_set(uiBut *but,
Cleanup: split button search callbacks into their own struct
2020-05-07 23:16:05 +10:00
uiButSearchCreateFn search_create_fn,
uiButSearchUpdateFn search_update_fn,
Fix T60815: drag & drop crash when search menu is opened immediately after. Patch by matc, some further refactoring by me. Differential Revision: https://developer.blender.org/D4250
2019-03-20 19:26:54 +01:00
void *arg,
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
bool free_arg,
UI: custom free function improvements This changes `UI_but_func_tooltip_set` so that it allows passing a custom free function, which has two benefits: * The caller can pass `null` to indicate that the value should not be freed. * Arbitrary c++ data can be passed to the callback (before the struct had to be trivially destructible). I added `uiFreeArgFunc` and used it in other places where appropriate. Differential Revision: https://developer.blender.org/D11738
2021-06-30 17:27:54 +02:00
uiFreeArgFunc search_arg_free_fn,
Cleanup: callback naming for search button & update doc-strings Callback naming didn't always make it clear which function updated the search contents and the function used to execute the action.
2020-05-08 12:01:35 +10:00
uiButHandleFunc search_exec_fn,
Fix T60815: drag & drop crash when search menu is opened immediately after. Patch by matc, some further refactoring by me. Differential Revision: https://developer.blender.org/D4250
2019-03-20 19:26:54 +01:00
void *active);
UI: support context menu in menu search popup
2020-05-07 23:16:22 +10:00
void UI_but_func_search_set_context_menu(uiBut *but, uiButSearchContextMenuFn context_menu_fn);
UI: show tool-tips in menu search
2020-05-11 18:37:43 +10:00
void UI_but_func_search_set_tooltip(uiBut *but, uiButSearchTooltipFn tooltip_fn);
Nodes: Add node group assets to search menus Currently node group assets are supported, but using them by dragging from the asset browser is cumbersome. This patch adds all node group assets from user asset libraries and the current file libraries to the add node search menu and the link drag search menu. Node groups added through the search will have their "options" hidden, meaning the data-block selector is displayed. This helps keep the UI clean, and the selector shouldn't be necessary anyway. To make that possible, metadata like the node tree type and its inputs and outputs has to be saved in the file. This requires re-saving the files that contain the assets with the patch applied. The node add search operator is moved from Python to C++ to ease development and allow more flexibility. It supports a tooltip that gives the description of assets. Currently the node groups are added with the asset system's existing "Append & Reuse" behavior. It's likely that linking should be possible in the future too, but for now the idea is to use the more foolproof option that doesn't create dependencies between files. Because loading assets can potentially take a long time, the search menu refreshes its items as new assets are loaded. However, changing the search field is necessary to see the update. Differential Revision: https://developer.blender.org/D15568
2022-09-19 11:57:10 -05:00
void UI_but_func_search_set_listen(uiBut *but, uiButSearchListenFn listen_fn);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \param search_sep_string: when not NULL, this string is used as a separator,
* showing the icon and highlighted text after the last instance of this string.
*/
Cleanup: split search menu separator argument into own function
2020-05-07 23:16:16 +10:00
void UI_but_func_search_set_sep_string(uiBut *but, const char *search_sep_string);
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
void UI_but_func_search_set_results_are_suggestions(uiBut *but, bool value);
Cleanup: split search menu separator argument into own function
2020-05-07 23:16:16 +10:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Height in pixels, it's using hard-coded values still.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int UI_searchbox_size_y();
int UI_searchbox_size_x();
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Check if a string is in an existing search box.
*/
Revert "Add red alert in UI controls for datablock pointer properties" This reverts commit f5bc8ad4ce87165fc0648f1cd8c0ae1fb5f07281. We agreed there needs to be a better solution for this, see comments in rBf5bc8ad4ce87165.
2017-05-05 00:44:06 +02:00
int UI_search_items_find_index(uiSearchItems *items, const char *name);
2.5 Part one of new text button type: SEARCH_MENU This opens a popup showing all matches for a typed string, nice for object names, materials, operators, and so on. Warning: Currently menu doesn't function yet! Only draws choices. As test I've added an operator search button in top bar. It only shows operators that can be used in this context now. Also that is part of the WIP, tomorrow more fun :)
2009-06-02 18:10:06 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Adds a hint to the button which draws right aligned, grayed out and never clipped.
*/
Spreadsheet: Dataset region for spreadsheet editor This patch adds a left aligned sidebar to the spreadsheet editor. This Sidebar can be used to navigate the geometry component types and attribute domains. It also provides a quick overview of domain sizes. It replaces the two dropdowns in the regions header. Next step will be to add the domain cycling shortcut using the CTRL + mouse wheel. Reviewer: Dalai Felinto (dfelinto), Julian Eisel (Severin), Hans Goudey (HooglyBoogly). Differential Revision: https://developer.blender.org/D11046
2021-06-25 07:57:24 +02:00
void UI_but_hint_drawstr_set(uiBut *but, const char *string);
UI: Icon number indicator for data-blocks Adds the possibility of having a little number on top of icons. At the moment this is used for: * Outliner * Node Editor bread-crumb * Node Group node header For the outliner there is almost no functional change. It is mostly a refactor to handle the indicators as part of the icon shader instead of the outliner draw code. (note that this was already recently changed in a5d3b648e3e2). The difference is that now we use rounded border rectangle instead of circles, and we can go up to 999 elements. So for the outliner this shows the number of collapsed elements of a certain type (e.g., mesh objects inside a collapsed collection). For the node editors is being used to show the use count for the data-block. This is important for the node editor, so users know whether the node-group they are editing (or are about to edit) is used elsewhere. This is particularly important when the Node Options are hidden, which is the default for node groups appended from the asset libraries. --- Note: This can be easily enabled for ID templates which can then be part of T84669. It just need to call UI_but_icon_indicator_number_set in the function template_add_button_search_menu. --- Special thanks Clément Foucault for the help figuring out the shader, Julian Eisel for the help navigating the UI code, and Pablo Vazquez for the collaboration in this design solution. For images showing the result check the Differential Revision. Differential Revision: https://developer.blender.org/D16284
2022-10-20 16:37:07 +02:00
void UI_but_icon_indicator_number_set(uiBut *but, const int indicator_number);
Refactor: Port spreadsheet data set to UI tree view This patch removes a bunch of specific code for drawing the spreadsheet data set region, which was an overly specific solution for a generic UI. Nowadays, the UI tree view API used for asset browser catalogs is a much better way to implement this behavior. To make this possible, the tree view API is extended in a few ways. Collapsibility can now be turned off, and whether an item should be active is moved to a separate virtual function. The only visual change is that the items are now drawn in a box, just like the asset catalog. Differential Revision: https://developer.blender.org/D13198
2021-11-19 17:36:11 -05:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_node_link_set(uiBut *but, bNodeSocket *socket, const float draw_color[4]);
UI: Draw real node sockets for node input buttons For buttons representing node inputs (e.g. in the material properties) rather than drawing some generic socket icon, the actual sockets are drawn now. That includes color, shape and the selection outline. This should make it easier to understand what these buttons relate to. Screenshots: {F8469252}, {F8469248} (The left alignment will be done in a follow-up commit.) Differential Revision: https://developer.blender.org/D7409 Reviewed by: Brecht Van Lommel, Clément Foucault, William Reynish
2020-04-16 15:09:49 +02:00
UI Code Quality: Use derived struct for number buttons For the man rationale behind this design, see 49f088e2d093. Further, this removes users of uiBut.a1/uiBut.a2, which is a very ugly design choice (hard to reason about). Note that I had to do rather ugly, specific exceptions for the number buttons in `ui_def_but_rna()`. But once all users of a1/a2 are removed, this special handling shouldn't be needed anymore. I also had to move a sanity check out of the button definition. It's now moved into a new debug only sanity checking function executed when finishing the layout definition (block end).
2020-09-04 21:18:45 +02:00
void UI_but_number_step_size_set(uiBut *but, float step_size);
void UI_but_number_precision_set(uiBut *but, float precision);
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_block_func_handle_set(uiBlock *block, uiBlockHandleFunc func, void *arg);
void UI_block_func_butmenu_set(uiBlock *block, uiMenuHandleFunc func, void *arg);
void UI_block_func_set(uiBlock *block, uiButHandleFunc func, void *arg1, void *arg2);
void UI_block_funcN_set(uiBlock *block, uiButHandleNFunc funcN, void *argN, void *arg2);
2.5 Outliner: brought back to near full functioning: - proper operators, like for open/close items, exec operations (note: select is still same operator as activate, should become modal ops later) - rename works again (ctrl+click) - proper notifiers for redraws - select / extend select works again - editmode in/out works again - enter key opens/closes again - right mouse operations work again Didn't do: - options for Sequence strips - signals to change button views on clicks - error/warning messages UI: - added new uiButSetRenameFunc(), which passes on the old name - added uiButActiveOnly(), which ensures a button gets created in active state, and gets removed when used. Needed for editing names in outliner. Andrea: check outliner.c for uiButActiveOnly(), very easy to use! Also: - Added posemode operator, CTRL+TAB tied to it.
2009-07-25 13:40:59 +00:00
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_but_func_rename_set(uiBut *but, uiButHandleRenameFunc func, void *arg1);
void UI_but_func_set(uiBut *but, uiButHandleFunc func, void *arg1, void *arg2);
void UI_but_funcN_set(uiBut *but, uiButHandleNFunc funcN, void *argN, void *arg2);
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_but_func_complete_set(uiBut *but, uiButCompleteFunc func, void *arg);
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_func_drawextra_set(uiBlock *block,
void (*func)(const bContext *C, void *, void *, void *, rcti *rect),
void *arg1,
void *arg2);
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
UI: support cycling callback for non RNA menus
2015-11-16 06:26:25 +11:00
void UI_but_func_menu_step_set(uiBut *but, uiMenuStepFunc func);
UI: custom free function improvements This changes `UI_but_func_tooltip_set` so that it allows passing a custom free function, which has two benefits: * The caller can pass `null` to indicate that the value should not be freed. * Arbitrary c++ data can be passed to the callback (before the struct had to be trivially destructible). I added `uiFreeArgFunc` and used it in other places where appropriate. Differential Revision: https://developer.blender.org/D11738
2021-06-30 17:27:54 +02:00
void UI_but_func_tooltip_set(uiBut *but, uiButToolTipFunc func, void *arg, uiFreeArgFunc free_arg);
Fix tooltip showing button label redundantly (regression) With 9d0907560a, button tooltips would now often display the label even though it's already visible in the button itself. This fix brings back the old logic for displaying the label, but it's still possible to override the label via the callback introduced in the earlier commit. Comments are updated/added here to make the behavior more clear. Pull Request: https://projects.blender.org/blender/blender/pulls/110469
2023-09-21 14:49:53 +02:00
/**
* Enable a custom quick tooltip label. That is, a short tooltip that appears faster than the full
* one and only shows the label string returned by \a func. After a short delay the full tooltip is
* shown, including the same label.
*/
UI: Refactor quick label tooltip implementation for buttons No user visible changes expected. Used in the asset shelf branch, see #104831. These tooltips only show a label string and appear after a shorter timeout than the regular tooltips. After the regular tooltip timeout they expand to the full tooltip. The toolbar and properties editor navigation tabs make use of this already. The changes here enable more control over quick label tooltips, making them usable in more cases, and less ad-hoc. Main changes: - Refactors internal logic so a single `UI_BUT_HAS_TOOLTIP_LABEL` button flag can be used to enable quick label tooltips. This decentralizes logic in a way that's more consistent and extensible. - Custom callback to return a quick label. This is useful when a label tooltip should be displayed even when there is no button string set. E.g. in the asset shelf with "Show Names" disabled. Pull Request: https://projects.blender.org/blender/blender/pulls/110200
2023-07-25 16:22:31 +02:00
void UI_but_func_tooltip_label_set(uiBut *but, std::function<std::string(const uiBut *but)> func);
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
Cleanup: use lowercase ui prefix for enum, rename Color -> ColorID Follow current conventions for types e.g. uiFontStyle, uiBlock etc. Also rename UiTooltipColor to uiTooltipColorID since this isn't storing the color.
2023-09-17 09:01:45 +10:00
typedef enum uiTooltipStyle {
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
UI_TIP_STYLE_NORMAL = 0, /* Regular text. */
UI_TIP_STYLE_HEADER, /* Header text. */
Cleanup: format, spelling
2023-09-17 09:01:43 +10:00
UI_TIP_STYLE_MONO, /* Mono-spaced text. */
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
UI_TIP_STYLE_IMAGE, /* Image field. */
UI: Allow Tooltip Padding In Any Order Allow padding anywhere within a tooltip, not just before the current field, by adding a new field type of UI_TIP_STYLE_SPACER. Pull Request: https://projects.blender.org/blender/blender/pulls/112487
2023-10-13 22:34:43 +02:00
UI_TIP_STYLE_SPACER, /* Padding to separate sections. */
Cleanup: use lowercase ui prefix for enum, rename Color -> ColorID Follow current conventions for types e.g. uiFontStyle, uiBlock etc. Also rename UiTooltipColor to uiTooltipColorID since this isn't storing the color.
2023-09-17 09:01:45 +10:00
} uiTooltipStyle;
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
Cleanup: use lowercase ui prefix for enum, rename Color -> ColorID Follow current conventions for types e.g. uiFontStyle, uiBlock etc. Also rename UiTooltipColor to uiTooltipColorID since this isn't storing the color.
2023-09-17 09:01:45 +10:00
typedef enum uiTooltipColorID {
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
UI_TIP_LC_MAIN = 0, /* Color of primary text. */
UI_TIP_LC_VALUE, /* Color for the value of buttons (also shortcuts). */
UI_TIP_LC_ACTIVE, /* Color of titles of active enum values. */
UI_TIP_LC_NORMAL, /* Color of regular text. */
UI_TIP_LC_PYTHON, /* Color of python snippets. */
UI_TIP_LC_ALERT, /* Warning text color, eg: why operator can't run. */
UI_TIP_LC_MAX
Cleanup: use lowercase ui prefix for enum, rename Color -> ColorID Follow current conventions for types e.g. uiFontStyle, uiBlock etc. Also rename UiTooltipColor to uiTooltipColorID since this isn't storing the color.
2023-09-17 09:01:45 +10:00
} uiTooltipColorID;
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
void UI_but_func_tooltip_custom_set(uiBut *but,
uiButToolTipCustomFunc func,
void *arg,
uiFreeArgFunc free_arg);
Cleanup: document ownership for uiTooltipField, add function attributes - Document ownership. - Make some arguments const. - Use function style casts. - Make width/height into a size[2].
2023-09-17 09:01:45 +10:00
/**
* \param text: Allocated text (transfer ownership to `data`) or null.
* \param suffix: Allocated text (transfer ownership to `data`) or null.
*/
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
void UI_tooltip_text_field_add(struct uiTooltipData *data,
char *text,
char *suffix,
Cleanup: use lowercase ui prefix for enum, rename Color -> ColorID Follow current conventions for types e.g. uiFontStyle, uiBlock etc. Also rename UiTooltipColor to uiTooltipColorID since this isn't storing the color.
2023-09-17 09:01:45 +10:00
const uiTooltipStyle style,
const uiTooltipColorID color_id,
Cleanup: document ownership for uiTooltipField, add function attributes - Document ownership. - Make some arguments const. - Use function style casts. - Make width/height into a size[2].
2023-09-17 09:01:45 +10:00
const bool is_pad = false) ATTR_NONNULL(1);
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
Cleanup: document ownership for uiTooltipField, add function attributes - Document ownership. - Make some arguments const. - Use function style casts. - Make width/height into a size[2].
2023-09-17 09:01:45 +10:00
/**
* \param image: Image buffer (duplicated, ownership is *not* transferred to `data`).
Fix error from 106d2bb3120b579fdf11336baf4e1cf8669bc53b Swapped width/height for the image size.
2023-09-17 11:32:41 +10:00
* \param image_size: Display size for the image (pixels without UI scale applied).
Cleanup: document ownership for uiTooltipField, add function attributes - Document ownership. - Make some arguments const. - Use function style casts. - Make width/height into a size[2].
2023-09-17 09:01:45 +10:00
*/
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
void UI_tooltip_image_field_add(struct uiTooltipData *data,
Cleanup: document ownership for uiTooltipField, add function attributes - Document ownership. - Make some arguments const. - Use function style casts. - Make width/height into a size[2].
2023-09-17 09:01:45 +10:00
const struct ImBuf *image,
const short image_size[2]) ATTR_NONNULL(1, 2, 3);
UI: Custom Tooltips with Optional Images This adds an optional uiBut callback that allows creating a tooltip line-by-line with specified style and color in any order. It also allows adding images as well to create very informative tooltips. Pull Request: https://projects.blender.org/blender/blender/pulls/105905
2023-09-15 21:06:30 +02:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Recreate tool-tip (use to update dynamic tips)
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_tooltip_refresh(bContext *C, uiBut *but);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Removes tool-tip timer from active but
* (meaning tool-tip is disabled until it's re-enabled again).
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_tooltip_timer_remove(bContext *C, uiBut *but);
UI: add optional tip callback to uiBut, and use it for per-item tooltips in UIList. When defined, uiBut->tip_func is called when button's tip is generated. This allows for advanced, dynamic generation of tooltips. For now, only used by UIList, which can now optionaly use a given string property of each item for its tooltip. Thanks to Campbell for the reviews!
2015-02-11 00:06:03 +01:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_textbutton_activate_rna(const bContext *C,
ARegion *region,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const void *rna_poin_data,
const char *rna_prop_id);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_textbutton_activate_but(const bContext *C, uiBut *but);
Usablity: In text editor, the CTRL+F find now opens property region (or keeps it) and activates the search button for input. That's already nice! But next step should be to do a search on exit of the button (or while typing). That's stuff I need Campbell to help with though. Notes: - Probably Py api for property buttons could get an "operator=" arg? - The warning menu "not found" should go away - I also suggest to make "wrap" search default for new editors
2013-03-24 13:43:40 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* push a new event onto event queue to activate the given button
* (usually a text-field) upon entering a popup
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_focus_on_enter_event(wmWindow *win, uiBut *but);
UI Tweaks: Text field in Rename Markers popup now gets focus when the popup appears, saving an extra click I've separated out the "XXX"-'d event-adding-hack section from the search-menu code into a separate API function (as recommended there). This call is used to make sure that textboxes in popups can get activated by default, to allow typing immediately.
2011-02-15 01:24:12 +00:00
UI: Add UILayout.operator_menu_hold This is an operator button that opens a menu when the button is held.
2017-11-02 04:30:07 +11:00
void UI_but_func_hold_set(uiBut *but, uiButHandleHoldFunc func, void *argN);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *UI_but_extra_operator_icon_add(uiBut *but,
const char *opname,
wmOperatorCallContext opcontext,
int icon);
wmOperatorType *UI_but_extra_operator_icon_optype_get(uiButExtraOpIcon *extra_icon);
PointerRNA *UI_but_extra_operator_icon_opptr_get(uiButExtraOpIcon *extra_icon);
UI: Refactor and improve buttton extra icons Without this patch there could only be one superimposed icon and the operators were hard coded for the button types. This keeps the previous, sort of predefined extra icons working in a rather generic way, but allows adding specific ones for specific case through `UI_but_extra_operator_icon_set()`. Reviewed by: Campbell Barton Differential Revision: https://developer.blender.org/D5730
2019-09-09 16:34:16 +02:00
UI: Add initial "grid view" Part of T98560. See https://wiki.blender.org/wiki/Source/Interface/Views Adds all the basic functionality needed for grid views. They display items in a grid of rows and columns, typically with a preview image and a label underneath. Think of the main region in the Asset Browser. Current features: - Active item - Notifier listening (also added this to the tree view) - Performance: Skip adding buttons that are not scrolled into view (solves performance problems for big asset libraries, for example). - Custom item size - Preview items (items that draw a preview with a label underneath) - Margins between items scale so the entire region width is filled with column, rather than leaving a big empty block at the right if there's not enough space for another column (like the File and current Asset Browser does it). - "Data-View Item" theme colors. Not shown in the UI yet. No user visible changes expected since the grid views aren't used for anything yet. This was developed as part of a rewrite of the Asset Browser UI (`asset-browser-grid-view` branch), see T95653. There's no reason to keep this part in a branch, continuing development in master makes things easier. Grid and tree views have a lot of very similar code, so I'm planning to unify them to a degree. I kept things separate for the start to first find out how much and what exactly makes sense to override.
2022-06-16 11:29:20 +02:00
/**
UI: Asset Shelf Support (Experimental Feature) No user visible changes expected, except of new experimental feature option. ------------------------------------------------------------------------------ This introduces asset shelves as a new standard UI element for accessing assets. Based on the current context (like the active mode and/or tool), they can provide assets for specific workflows/tasks. As such they are more limited in functionality than the asset browser, but a lot more efficient for certain tasks. The asset shelf is developed as part of the brush assets project (see #101895), but is also meant to replace the current pose library UI. Support for asset shelves can quite easily be added to different editor types, the following commit will add support for the 3D View. If an editor type supports asset shelves, add-ons can chose to register an asset shelf type for an editor with just a few lines of Python. It should be possible to entirely remove `UILayout.asset_view_template()` once asset shelves are non-experimental. Some changes are to be expected still, see #107881. Task: #102879 Brush asset workflow blog post: https://code.blender.org/2022/12/brush-assets-workflow/ Initial technical documentation: https://developer.blender.org/docs/asset_system/user_interface/asset_shelf/ Pull Request: #104831
2023-08-03 16:54:39 +02:00
* Get the scaled size for a preview button (typically #UI_BTyPE_PREVIEW_TILE) based on \a
* size_px plus padding.
UI: Add initial "grid view" Part of T98560. See https://wiki.blender.org/wiki/Source/Interface/Views Adds all the basic functionality needed for grid views. They display items in a grid of rows and columns, typically with a preview image and a label underneath. Think of the main region in the Asset Browser. Current features: - Active item - Notifier listening (also added this to the tree view) - Performance: Skip adding buttons that are not scrolled into view (solves performance problems for big asset libraries, for example). - Custom item size - Preview items (items that draw a preview with a label underneath) - Margins between items scale so the entire region width is filled with column, rather than leaving a big empty block at the right if there's not enough space for another column (like the File and current Asset Browser does it). - "Data-View Item" theme colors. Not shown in the UI yet. No user visible changes expected since the grid views aren't used for anything yet. This was developed as part of a rewrite of the Asset Browser UI (`asset-browser-grid-view` branch), see T95653. There's no reason to keep this part in a branch, continuing development in master makes things easier. Grid and tree views have a lot of very similar code, so I'm planning to unify them to a degree. I kept things separate for the start to first find out how much and what exactly makes sense to override.
2022-06-16 11:29:20 +02:00
*/
UI: Asset Shelf Support (Experimental Feature) No user visible changes expected, except of new experimental feature option. ------------------------------------------------------------------------------ This introduces asset shelves as a new standard UI element for accessing assets. Based on the current context (like the active mode and/or tool), they can provide assets for specific workflows/tasks. As such they are more limited in functionality than the asset browser, but a lot more efficient for certain tasks. The asset shelf is developed as part of the brush assets project (see #101895), but is also meant to replace the current pose library UI. Support for asset shelves can quite easily be added to different editor types, the following commit will add support for the 3D View. If an editor type supports asset shelves, add-ons can chose to register an asset shelf type for an editor with just a few lines of Python. It should be possible to entirely remove `UILayout.asset_view_template()` once asset shelves are non-experimental. Some changes are to be expected still, see #107881. Task: #102879 Brush asset workflow blog post: https://code.blender.org/2022/12/brush-assets-workflow/ Initial technical documentation: https://developer.blender.org/docs/asset_system/user_interface/asset_shelf/ Pull Request: #104831
2023-08-03 16:54:39 +02:00
int UI_preview_tile_size_x(const int size_px CPP_ARG_DEFAULT(96));
int UI_preview_tile_size_y(const int size_px CPP_ARG_DEFAULT(96));
int UI_preview_tile_size_y_no_label(const int size_px CPP_ARG_DEFAULT(96));
UI: Add initial "grid view" Part of T98560. See https://wiki.blender.org/wiki/Source/Interface/Views Adds all the basic functionality needed for grid views. They display items in a grid of rows and columns, typically with a preview image and a label underneath. Think of the main region in the Asset Browser. Current features: - Active item - Notifier listening (also added this to the tree view) - Performance: Skip adding buttons that are not scrolled into view (solves performance problems for big asset libraries, for example). - Custom item size - Preview items (items that draw a preview with a label underneath) - Margins between items scale so the entire region width is filled with column, rather than leaving a big empty block at the right if there's not enough space for another column (like the File and current Asset Browser does it). - "Data-View Item" theme colors. Not shown in the UI yet. No user visible changes expected since the grid views aren't used for anything yet. This was developed as part of a rewrite of the Asset Browser UI (`asset-browser-grid-view` branch), see T95653. There's no reason to keep this part in a branch, continuing development in master makes things easier. Grid and tree views have a lot of very similar code, so I'm planning to unify them to a degree. I kept things separate for the start to first find out how much and what exactly makes sense to override.
2022-06-16 11:29:20 +02:00
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
/* Autocomplete
*
* Tab complete helper functions, for use in uiButCompleteFunc callbacks.
* Call begin once, then multiple times do_name with all possibilities,
* and finally end to finish and get the completed name. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct AutoComplete;
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
Fix: tab completing a filepath name in file browsers asks to create a new directory if name was not fully matched When hitting tab to complete a directory name in the filepath field in the filebrowser Blender shows a "create new directory?" popup, if the beginning of directory name typed in the field matches many entries. For example if you have directories in the open directory called "test123" and "test456", typing "te", tab would complete up to "test", but ask to create a new folder with the name "test". This patch unsets the boolean storing the info about changing filepath if the folder with the completed name does not exist. Reviewed By: brecht Differential Revision: http://developer.blender.org/D10
2013-11-19 16:31:48 +01:00
#define AUTOCOMPLETE_NO_MATCH 0
#define AUTOCOMPLETE_FULL_MATCH 1
#define AUTOCOMPLETE_PARTIAL_MATCH 2
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
AutoComplete *UI_autocomplete_begin(const char *startname, size_t maxlen);
void UI_autocomplete_update_name(AutoComplete *autocpl, const char *name);
int UI_autocomplete_end(AutoComplete *autocpl, char *autoname);
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
Cleanup: Move dragging code for buttons to own file Moves code for managing dragging data from buttons to a separate file. This way all this closely related code is in one location, making it easier to see how it all relates, and easier to find.
2022-05-31 15:06:57 +02:00
/* Button drag-data (interface_drag.cc).
*
* Functions to set drag data for buttons. This enables dragging support, whereby the drag data is
* "dragged", not the button itself. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_drag_set_id(uiBut *but, ID *id);
Cleanup: Move dragging code for buttons to own file Moves code for managing dragging data from buttons to a separate file. This way all this closely related code is in one location, making it easier to see how it all relates, and easier to find.
2022-05-31 15:06:57 +02:00
/**
* Set an image to display while dragging. This works for any drag type (`WM_DRAG_XXX`).
* Not to be confused with #UI_but_drag_set_image(), which sets up dragging of an image.
Revert release branch only commit after merge This is a revert of a revert, because the initial revert is only supposed to be in the release branch. This reverts commit 3eed00dc546b5930b255572901915ccbc26c0e69.
2023-02-20 11:51:16 +01:00
*
* Sets #UI_BUT_DRAG_FULL_BUT so the full button can be dragged.
Cleanup: Move dragging code for buttons to own file Moves code for managing dragging data from buttons to a separate file. This way all this closely related code is in one location, making it easier to see how it all relates, and easier to find.
2022-05-31 15:06:57 +02:00
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_drag_attach_image(uiBut *but, const ImBuf *imb, float scale);
Cleanup: Remove unnecessary C API for asset representation Now that almost all code is in C++, this is unnecessary and just confuses things with multiple entry points to the same code. Pull Request: https://projects.blender.org/blender/blender/pulls/109661
2023-07-04 14:46:19 +02:00
Cleanup: Move dragging code for buttons to own file Moves code for managing dragging data from buttons to a separate file. This way all this closely related code is in one location, making it easier to see how it all relates, and easier to find.
2022-05-31 15:06:57 +02:00
/**
Revert release branch only commit after merge This is a revert of a revert, because the initial revert is only supposed to be in the release branch. This reverts commit 3eed00dc546b5930b255572901915ccbc26c0e69.
2023-02-20 11:51:16 +01:00
* Sets #UI_BUT_DRAG_FULL_BUT so the full button can be dragged.
Cleanup: Move dragging code for buttons to own file Moves code for managing dragging data from buttons to a separate file. This way all this closely related code is in one location, making it easier to see how it all relates, and easier to find.
2022-05-31 15:06:57 +02:00
* \param asset: May be passed from a temporary variable, drag data only stores a copy of this.
*/
void UI_but_drag_set_asset(uiBut *but,
Cleanup: Remove unnecessary C API for asset representation Now that almost all code is in C++, this is unnecessary and just confuses things with multiple entry points to the same code. Pull Request: https://projects.blender.org/blender/blender/pulls/109661
2023-07-04 14:46:19 +02:00
const blender::asset_system::AssetRepresentation *asset,
Assets: Rename "Import Type" to "Import Method" in code/BPY It was already called that way in the UI, since it's referring to a behavior, not a type. Update the code to match that. Note that this is a BPY compatibility breaking change for 4.0.
2023-09-26 16:20:49 +02:00
int import_method, /* eAssetImportMethod */
Cleanup: Move dragging code for buttons to own file Moves code for managing dragging data from buttons to a separate file. This way all this closely related code is in one location, making it easier to see how it all relates, and easier to find.
2022-05-31 15:06:57 +02:00
int icon,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const ImBuf *imb,
Cleanup: Move dragging code for buttons to own file Moves code for managing dragging data from buttons to a separate file. This way all this closely related code is in one location, making it easier to see how it all relates, and easier to find.
2022-05-31 15:06:57 +02:00
float scale);
Cleanup: Remove unnecessary C API for asset representation Now that almost all code is in C++, this is unnecessary and just confuses things with multiple entry points to the same code. Pull Request: https://projects.blender.org/blender/blender/pulls/109661
2023-07-04 14:46:19 +02:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_drag_set_rna(uiBut *but, PointerRNA *ptr);
UI: Refactor path dropping so logic doesn't depend on icons No behavior change intended. Many file drag & drop handlers used the icon assigned for dragging to determine what type of data is dragged. This is fragile, for example changing an icon would break drag & drop (!). This happened a few times, e.g. see 3788003cda. It's also causing problems with #104830, which changes how file browser drag data is handled. Instead use the file extension to determine the file type.
2023-02-27 16:31:31 +01:00
/**
* Enable dragging a path from this button.
* \param path: The path to drag. The passed string may be destructed, button keeps a copy.
*/
void UI_but_drag_set_path(uiBut *but, const char *path);
Cleanup: Move dragging code for buttons to own file Moves code for managing dragging data from buttons to a separate file. This way all this closely related code is in one location, making it easier to see how it all relates, and easier to find.
2022-05-31 15:06:57 +02:00
void UI_but_drag_set_name(uiBut *but, const char *name);
/**
* Value from button itself.
*/
void UI_but_drag_set_value(uiBut *but);
Revert release branch only commit after merge This is a revert of a revert, because the initial revert is only supposed to be in the release branch. This reverts commit 3eed00dc546b5930b255572901915ccbc26c0e69.
2023-02-20 11:51:16 +01:00
UI: Refactor path dropping so logic doesn't depend on icons No behavior change intended. Many file drag & drop handlers used the icon assigned for dragging to determine what type of data is dragged. This is fragile, for example changing an icon would break drag & drop (!). This happened a few times, e.g. see 3788003cda. It's also causing problems with #104830, which changes how file browser drag data is handled. Instead use the file extension to determine the file type.
2023-02-27 16:31:31 +01:00
/**
* Sets #UI_BUT_DRAG_FULL_BUT so the full button can be dragged.
* \param path: The path to drag. The passed string may be destructed, button keeps a copy.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_drag_set_image(uiBut *but, const char *path, int icon, const ImBuf *imb, float scale);
Cleanup: Move dragging code for buttons to own file Moves code for managing dragging data from buttons to a separate file. This way all this closely related code is in one location, making it easier to see how it all relates, and easier to find.
2022-05-31 15:06:57 +02:00
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
/* Panels
*
* Functions for creating, freeing and drawing panels. The API here
* could use a good cleanup, though how they will function in 2.5 is
* not clear yet so we postpone that. */
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_panels_begin(const bContext *C, ARegion *region);
void UI_panels_end(const bContext *C, ARegion *region, int *r_x, int *r_y);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Draw panels, selected (panels currently being dragged) on top.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_panels_draw(const bContext *C, ARegion *region);
UI: * For new buttons spaces, automatically set horizontal/vertical align depending on size, instead of free. * Cleaned up the UI panel API. There's now a new uiBeginPanel function which takes a panel type, and a uiEndPanel which takes the final size. uiNewPanel* functions will be phased out. * Animate the re-alignment when a panel size changes, e.g. when enabling dupliframes. * Load ui scripts from the release/ folder first if it is available. This makes it easier to edit ui scripts, since it will directly use the original files which avoids having to run the build system. * Improve editing of panel types while blender is open. That means fixing some issues with lacking updates, overlaps, strange ordering. It even does an animation now when the panel resizes.
2009-04-16 21:39:45 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
Panel *UI_panel_find_by_type(ListBase *lb, const PanelType *pt);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \note \a panel should be return value from #UI_panel_find_by_type and can be NULL.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
Panel *UI_panel_begin(
ARegion *region, ListBase *lb, uiBlock *block, PanelType *pt, Panel *panel, bool *r_open);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Create the panel header button group, used to mark which buttons are part of
* panel headers for the panel search process that happens later. This Should be
* called before adding buttons for the panel's header layout.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_panel_header_buttons_begin(Panel *panel);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Finish the button group for the panel header to avoid putting panel body buttons in it.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_panel_header_buttons_end(Panel *panel);
void UI_panel_end(Panel *panel, int width, int height);
UI: List Panel System This implements a general system to implement drag and drop, subpanels, and UI animation for the stack UIs in Blender. There are NO functional changes in this patch, but it makes it relatively trivial to implement these features for stacks. The biggest complication to using panels to implement the UI for lists is that there can be multiple modifiers of the same type. Currently there is an assumed 1 to 1 relationship between every panel and its type, but there can be multiple list items of the same type, so we have to break this relationship. The mapping between panels and their data is stored with an index in the panel's runtime struct. To make use the system for a list like modifiers, four components must be added: 1. A panel type defined and registered for each list data type, with a known mapping between list data types and panel idnames. 1. A function called by interface code to build the add the panel layouts with the provided helper functions. - UI_panel_list_matches_data will check if the panel list needs to be rebuilt. - UI_panels_free_instanced will remove the existing list panels - UI_panel_add_instanced adds a list panel of a given type. 3. An expand flag for the list data and implementations of get_list_data_expand_flag and set_list_data_expand_flag. 4. For reordering, the panel type's reorder callback. This is called when the instanced panels are drag-dropped. This requires implementing a "move to index" operator for the list data. Reviewed By: Severin, brecht Differential Revision: https://developer.blender.org/D7490
2020-05-26 15:39:49 -04:00
UI: Remove panel name size limit for complex character languages The previous limit of 63 bytes for the panel name was an issue for languages where characters use multiple bytes. The UI would show panel names truncated that had reasonably long/short names. It's easy to support dynamically sized strings here, so do that instead of using fixed size buffers. Fixes #111927. Pull Request: https://projects.blender.org/blender/blender/pulls/111979
2023-09-12 14:47:46 +02:00
/** Set the name that should be drawn in the UI. Should be a translated string. */
void UI_panel_drawname_set(Panel *panel, blender::StringRef name);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Set a context for this entire panel and its current layout. This should be used whenever panel
* callbacks that are called outside of regular drawing might require context. Currently it affects
* the #PanelType.reorder callback only.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_panel_context_pointer_set(Panel *panel, const char *name, PointerRNA *ptr);
Fix broken handling of constraints reordering with library overrides Alternative to D13291 (description partially copied from there). New drag & drop reordering code would call constraints reordering operator with the generic context, and not the one from the panel's layout. missing the "constraint" member which is mandatory for poll function to properly deal with override vs. local constraints. For this to work in a decent way, there needs to be some panel-wide context that we can restore when executing callbacks outside of the normal draw context. So similar to uiLayoutSetContextPointer() to set context on a layout level, this introduces UI_panel_context_pointer_set() for panel level context (this calls the former for the current panel root layout as well). Differential Revision: https://developer.blender.org/D13308
2021-11-23 18:32:23 +01:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Get the panel's expansion state, taking into account
* expansion set from property search if it applies.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_panel_is_closed(const Panel *panel);
bool UI_panel_is_active(const Panel *panel);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* For button layout next to label.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_panel_label_offset(const uiBlock *block, int *r_x, int *r_y);
bool UI_panel_should_show_background(const ARegion *region, const PanelType *panel_type);
int UI_panel_size_y(const Panel *panel);
bool UI_panel_is_dragging(const Panel *panel);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Find whether a panel or any of its sub-panels contain a property that matches the search filter,
* depending on the search process running in #UI_block_apply_search_filter earlier.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_panel_matches_search_filter(const Panel *panel);
bool UI_panel_can_be_pinned(const Panel *panel);
UI: various panels fixes. * Fix sometimes non-working close/open button. * Fix panels being a bit out of the view on startup. * Fix too large totrct region for view2d. * Fix wrong panel order when changing vertical <-> horizontal. * Fix wrong panel positions after switching contexts. * Fix an access of freed memory when collapsing panels. * Free align mode works again. * Animations work again.
2009-04-02 01:39:33 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_panel_category_is_visible(const ARegion *region);
void UI_panel_category_add(ARegion *region, const char *name);
PanelCategoryDyn *UI_panel_category_find(const ARegion *region, const char *idname);
PanelCategoryStack *UI_panel_category_active_find(ARegion *region, const char *idname);
const char *UI_panel_category_active_get(ARegion *region, bool set_fallback);
void UI_panel_category_active_set(ARegion *region, const char *idname);
void UI_panel_category_active_set_default(ARegion *region, const char *idname);
void UI_panel_category_clear_all(ARegion *region);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Draw vertical tabs on the left side of the region, one tab per category.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_panel_category_draw_all(ARegion *region, const char *category_id_active);
UI: Tabs categories for panels (D75) - works by defining panel categories, currently restricted to the toolbar. - no panels define bl_categories yet, so no user visible changes since tabs only show when there are multiple. - panel pinning is available in rmb menu or alt+lmb.
2013-12-17 03:21:55 +11:00
UI: Use instanced panel custom data instead of list index For modifier shortcuts we added a "custom_data" field to panels. This commit uses the same system for accessing the list data that corresponds to each panel. This way the context is only used once and the modifier for each panel can be accessed more easily later. This ends up being mostly a cleanup commit with a few small changes in interface_panel.c. The large changes in the UI functions are due to the fact that the panel custom data is now passed around as a single pointer instead of being created again for every panel. The list_index variable in Panel.runtime is removed as it's now unnecessary. Differential Revision: https://developer.blender.org/D8559
2020-09-02 14:13:26 -05:00
/* Panel custom data. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *UI_panel_custom_data_get(const Panel *panel);
PointerRNA *UI_region_panel_custom_data_under_cursor(const bContext *C, const wmEvent *event);
void UI_panel_custom_data_set(Panel *panel, PointerRNA *custom_data);
UI: Add shortcuts for modifier panels The shortcuts act on the modifier with its panel under the mouse. The following shortcuts are enabled by default: - Remove modifier: X, Delete - Apply modifier: Ctrl A - Duplicate modifier: Shift D More shortcuts can be added in the keymap. Each panel can now store a custom data RNA pointer, and a new function is added to get the custom data for the panel under the cursor. This custom data could be used to refactor the "List Panel System" to generalize it and integrate it further with RNA. The same functionality will be added in further commits where it applies to constraints, grease pencil modifiers, and effects. Differential Revision: https://developer.blender.org/D8031
2020-06-29 15:00:25 -04:00
Cleanup: spelling in comments
2022-06-03 13:39:37 +10:00
/* Poly-instantiated panels for representing a list of data. */
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Called in situations where panels need to be added dynamically rather than
* having only one panel corresponding to each #PanelType.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
Panel *UI_panel_add_instanced(const bContext *C,
ARegion *region,
ListBase *panels,
const char *panel_idname,
PointerRNA *custom_data);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Remove instanced panels from the region's panel list.
*
* \note Can be called with NULL \a C, but it should be avoided because
* handlers might not be removed.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_panels_free_instanced(const bContext *C, ARegion *region);
UI: List Panel System This implements a general system to implement drag and drop, subpanels, and UI animation for the stack UIs in Blender. There are NO functional changes in this patch, but it makes it relatively trivial to implement these features for stacks. The biggest complication to using panels to implement the UI for lists is that there can be multiple modifiers of the same type. Currently there is an assumed 1 to 1 relationship between every panel and its type, but there can be multiple list items of the same type, so we have to break this relationship. The mapping between panels and their data is stored with an index in the panel's runtime struct. To make use the system for a list like modifiers, four components must be added: 1. A panel type defined and registered for each list data type, with a known mapping between list data types and panel idnames. 1. A function called by interface code to build the add the panel layouts with the provided helper functions. - UI_panel_list_matches_data will check if the panel list needs to be rebuilt. - UI_panels_free_instanced will remove the existing list panels - UI_panel_add_instanced adds a list panel of a given type. 3. An expand flag for the list data and implementations of get_list_data_expand_flag and set_list_data_expand_flag. 4. For reordering, the panel type's reorder callback. This is called when the instanced panels are drag-dropped. This requires implementing a "move to index" operator for the list data. Reviewed By: Severin, brecht Differential Revision: https://developer.blender.org/D7490
2020-05-26 15:39:49 -04:00
Cleanup: use term SIZE instead of LEN for defines for buffer sizes Reserve "LEN" for lengths that don't include the null byte.
2023-06-26 10:09:57 +10:00
#define INSTANCED_PANEL_UNIQUE_STR_SIZE 16
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Find a unique key to append to the #PanelType.idname for the lookup to the panel's #uiBlock.
* Needed for instanced panels, where there can be multiple with the same type and identifier.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_list_panel_unique_str(Panel *panel, char *r_name);
UI: List Panel System This implements a general system to implement drag and drop, subpanels, and UI animation for the stack UIs in Blender. There are NO functional changes in this patch, but it makes it relatively trivial to implement these features for stacks. The biggest complication to using panels to implement the UI for lists is that there can be multiple modifiers of the same type. Currently there is an assumed 1 to 1 relationship between every panel and its type, but there can be multiple list items of the same type, so we have to break this relationship. The mapping between panels and their data is stored with an index in the panel's runtime struct. To make use the system for a list like modifiers, four components must be added: 1. A panel type defined and registered for each list data type, with a known mapping between list data types and panel idnames. 1. A function called by interface code to build the add the panel layouts with the provided helper functions. - UI_panel_list_matches_data will check if the panel list needs to be rebuilt. - UI_panels_free_instanced will remove the existing list panels - UI_panel_add_instanced adds a list panel of a given type. 3. An expand flag for the list data and implementations of get_list_data_expand_flag and set_list_data_expand_flag. 4. For reordering, the panel type's reorder callback. This is called when the instanced panels are drag-dropped. This requires implementing a "move to index" operator for the list data. Reviewed By: Severin, brecht Differential Revision: https://developer.blender.org/D7490
2020-05-26 15:39:49 -04:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
using uiListPanelIDFromDataFunc = void (*)(void *data_link, char *r_idname);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Check if the instanced panels in the region's panels correspond to the list of data the panels
* represent. Returns false if the panels have been reordered or if the types from the list data
* don't match in any way.
*
* \param data: The list of data to check against the instanced panels.
* \param panel_idname_func: Function to find the #PanelType.idname for each item in the data list.
* For a readability and generality, this lookup happens separately for each type of panel list.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_panel_list_matches_data(ARegion *region,
ListBase *data,
UI: List Panel System This implements a general system to implement drag and drop, subpanels, and UI animation for the stack UIs in Blender. There are NO functional changes in this patch, but it makes it relatively trivial to implement these features for stacks. The biggest complication to using panels to implement the UI for lists is that there can be multiple modifiers of the same type. Currently there is an assumed 1 to 1 relationship between every panel and its type, but there can be multiple list items of the same type, so we have to break this relationship. The mapping between panels and their data is stored with an index in the panel's runtime struct. To make use the system for a list like modifiers, four components must be added: 1. A panel type defined and registered for each list data type, with a known mapping between list data types and panel idnames. 1. A function called by interface code to build the add the panel layouts with the provided helper functions. - UI_panel_list_matches_data will check if the panel list needs to be rebuilt. - UI_panels_free_instanced will remove the existing list panels - UI_panel_add_instanced adds a list panel of a given type. 3. An expand flag for the list data and implementations of get_list_data_expand_flag and set_list_data_expand_flag. 4. For reordering, the panel type's reorder callback. This is called when the instanced panels are drag-dropped. This requires implementing a "move to index" operator for the list data. Reviewed By: Severin, brecht Differential Revision: https://developer.blender.org/D7490
2020-05-26 15:39:49 -04:00
uiListPanelIDFromDataFunc panel_idname_func);
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
/* Handlers
*
* Handlers that can be registered in regions, areas and windows for
* handling WM events. Mostly this is done automatic by modules such
* as screen/ if ED_KEYMAP_UI is set, or internally in popup functions. */
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_region_handlers_add(ListBase *handlers);
void UI_popup_handlers_add(bContext *C, ListBase *handlers, uiPopupBlockHandle *popup, char flag);
void UI_popup_handlers_remove(ListBase *handlers, uiPopupBlockHandle *popup);
void UI_popup_handlers_remove_all(bContext *C, ListBase *handlers);
UI: don't use operators anymore for handling user interface events, but rather a special UI handler which makes the code clearer. This UI handler is attached to the region along with other handlers, and also gets a callback when all handlers for the region are removed to ensure things are properly cleaned up. This should fix XXX's in the UI code related to events and context switching. Most of the changes are in interface_handlers.c, which was renamed from interface_ops.c, to convert operators to the UI handler. UI code notes: * uiBeginBlock/uiEndBlock/uiFreeBlocks now takes a context argument, this is required to properly cancel things like timers or tooltips when the region gets removed. * UI_add_region_handlers will add the region level UI handlers, to be used when adding keymap handlers etc. This replaces the UI keymap. * When the UI code starts a modal interaction (number sliding, text editing, opening a menu, ..), it will add an UI handler at the window level which will block events. Windowmanager changes: * Added an UI handler next to the existing keymap and operator modal handlers. It has an event handling and remove callback, and like operator modal handlers will remember the area and region if it is registered at the window level. * Removed the MESSAGE event. * Operator cancel and UI handler remove callbacks now get the window/area/region restored in the context, like the operator modal and UI handler event callbacks. * Regions now receive MOUSEMOVE events for the mouse going outside of the region. This was already happening for areas, but UI buttons are at the region level so we need it there. Issues: * Tooltips and menus stay open when switching to another window, and button highlight doesn't work without moving the mouse first when Blender starts up. I tried using some events like Q_FIRSTTIME, WINTHAW, but those don't seem to arrive.. * Timeline header buttons seem to be moving one pixel or so sometimes when interacting with them. * Seems not due to this commit, but UI and keymap handlers are leaking. It seems that handlers are being added to regions in all screens, also in regions of areas that are not visible, but these handlers are not removed. Probably there should only be handlers in visible regions?
2008-12-10 04:36:33 +00:00
2.5: UI & Menus * Cleaned up UI_interface.h a bit, and added some comments to organize things a bit and indicate what should be used when. * uiMenu* functions can now be used to create menus for headers too, this is done with a uiDefMenuBut, which takes a pointer to a uiMenuCreateFunc, that will then call uiMenu* functions. * Renamed uiMenuBegin/End to uiPupMenuBegin/End, as these are specific to making popup menus. Will convert the other conformation popup menu functions to use this too so we can remove some code. * Extended uiMenu functions, now there is is also: BooleanO, FloatO, BooleanR, EnumR, LevelEnumR, Separator. * Converted image window headers to use uiMenu functions, simplifies menu code further here. Did not remove the uiDefMenu functions as they are used in sequencer/view3d in some places now (will fix). * Also tried to simplify and fix bounds computation a bit better for popup menus. It tried to find out in advance what the size of the menu was but this is difficult with keymap strings in there, now uiPopupBoundsBlock can figure this out afterwards and ensure the popup is within the window bounds. Will convert some other functions to use this too.
2009-01-30 12:18:08 +00:00
/* Module
*
* init and exit should be called before using this module. init_userdef must
* be used to reinitialize some internal state if user preferences change. */
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_init();
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/* after reading userdef file */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_init_userdef();
void UI_reinit_font();
void UI_exit();
Port of part of the Interface code to 2.50. This is based on the current trunk version, so these files should not need merges. There's two things (clipboard and intptr_t) that are missing in 2.50 and commented out with XXX 2.48, these can be enabled again once trunk is merged into this branch. Further this is not all interface code, there are many parts commented out: * interface.c: nearly all button types, missing: links, chartab, keyevent. * interface_draw.c: almost all code, with some small exceptions. * interface_ops.c: this replaces ui_do_but and uiDoBlocks with two operators, making it non-blocking. * interface_regions: this is a part of interface.c, split off, contains code to create regions for tooltips, menus, pupmenu (that one is crashing currently), color chooser, basically regions with buttons which is fairly independent of core interface code. * interface_panel.c and interface_icons.c: not ported over, so no panels and icons yet. Panels should probably become (free floating) regions? * text.c: (formerly language.c) for drawing text and translation. this works but is using bad globals still and could be cleaned up. Header Files: * ED_datafiles.h now has declarations for datatoc_ files, so those extern declarations can be #included instead of repeated. * The user interface code is in UI_interface.h and other UI_* files. Core: * The API for creating blocks, buttons, etc is nearly the same still. Blocks are now created per region instead of per area. * The code was made non-blocking, which means that any changes and redraws should be possible while editing a button. That means though that we need some sort of persistence even though the blender model is to recreate buttons for each redraw. So when a new block is created, some matching happens to find out which buttons correspond to buttons in the previously created block, and for activated buttons some data is then copied over to the new button. * Added UI_init/UI_init_userdef/UI_exit functions that should initialize code in this module, instead of multiple function calls in the windowmanager. * Removed most static/globals from interface.c. * Removed UIafterfunc_ I don't think it's needed anymore, and not sure how it would integrate here? * Currently only full window redraws are used, this should become per region and maybe per button later. Operators: * Events are currently handled through two operators: button activate and menu handle. Operators may not be the best way to implement this, since there are currently some issues with events being missed, but they can become a special handler type instead, this should not be a big change. * The button activate operator runs as long as a button is active, and will handle all interaction with that button until the button is not activated anymore. This means clicking, text editing, number dragging, opening menu blocks, etc. * Since this operator has to be non-blocking, the ui_do_but code needed to made non-blocking. That means variables that were previously on the stack, now need to be stored away in a struct such that they can be accessed again when the operator receives more events. * Additionally the place in the ui_do_but code indicated the state, now that needs to be set explicit in order to handle the right events in the right state. So an activated button can be in one of these states: init, highlight, wait_flash, wait_release, wait_key_event, num_editing, text_editing, text_selecting, block_open, exit. * For each button type an ui_apply_but_* function has also been separated out from ui_do_but. This makes it possible to continuously apply the button as text is being typed for example, and there is an option in the code to enable this. Since the code non-blocking and can deal with the button being deleted even, it should be safe to do this. * When editing text, dragging numbers, etc, the actual data (but->poin) is not being edited, since that would mean data is being edited without correct updates happening, while some other part of blender may be accessing that data in the meantime. So data values, strings, vectors are written to a temporary location and only flush in the apply function. Regions: * Menus, color chooser, tooltips etc all create screen level regions. Such menu blocks give a handle to the button that creates it, which will contain the results of the menu block once a MESSAGE event is received from that menu block. * For this type of menu block the coordinates used to be in window space. They are still created that way and ui_positionblock still works with window coordinates, but after that the block and buttons are brought back to region coordinates since these are now contained in a region. * The flush/overdraw frontbuffer drawing code was removed, the windowmanager should have enough information with these screen level regions to have full control over what gets drawn when and to then do correct compositing. Testing: * The header in the time space currently has some buttons to test the UI code.
2008-11-11 18:31:32 +00:00
2.5: UI Layout Engine, initial code. * As a test, used by: * Object buttons, tried to make it match the mockup. * Text window header. * Text window properties panel. * Panel interaction with view2d is still problematic, need to make this work properly still. * Templates are very basic, the ones there are simple but already can follow the object buttons mockup quite closely. * It's based on a three level system: panels, templates and items. To get an idea of what that means in practice, see: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/UI_LayoutEngine#Panels.2C_Templates_and_Items
2009-03-13 13:38:41 +00:00
/* Layout
*
* More automated layout of buttons. Has three levels:
* - Layout: contains a number templates, within a bounded width or height.
* - Template: predefined layouts for buttons with a number of slots, each
* slot can contain multiple items.
* - Item: item to put in a template slot, being either an RNA property,
UI: Layout Engine * Buttons are now created first, and after that the layout is computed. This means the layout engine now works at button level, and makes it easier to write templates. Otherwise you had to store all info and create the buttons later. * Added interface_templates.c as a separate file to put templates in. These can contain regular buttons, and can be put in a Free layout, which means you can specify manual coordinates, but still get nested correct inside other layouts. * API was changed to allow better nesting. Previously items were added in the last added layout specifier, i.e. one level up in the layout hierarchy. This doesn't work well in always, so now when creating things like rows or columns it always returns a layout which you have to add the items in. All py scripts were updated to follow this. * Computing the layout now goes in two passes, first estimating the required width/height of all nested layouts, and then in the second pass using the results of that to decide on the actual locations. * Enum and array buttons now follow the direction of the layout, i.e. they are vertical or horizontal depending if they are in a column or row. * Color properties now get a color picker, and only get the additional RGB sliders with Expand=True. * File/directory string properties now get a button next to them for opening the file browse, though this is not implemented yet. * Layout items can now be aligned, set align=True when creating a column, row, etc. * Buttons now get a minimum width of one icon (avoids squashing icon buttons). * Moved some more space variables into Style.
2009-05-15 11:19:59 +00:00
* operator, label or menu. Also regular buttons can be used when setting
* uiBlockCurLayout. */
2.5: UI Layout Engine, initial code. * As a test, used by: * Object buttons, tried to make it match the mockup. * Text window header. * Text window properties panel. * Panel interaction with view2d is still problematic, need to make this work properly still. * Templates are very basic, the ones there are simple but already can follow the object buttons mockup quite closely. * It's based on a three level system: panels, templates and items. To get an idea of what that means in practice, see: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/UI_LayoutEngine#Panels.2C_Templates_and_Items
2009-03-13 13:38:41 +00:00
/* layout */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
enum {
UI_LAYOUT_HORIZONTAL = 0,
UI_LAYOUT_VERTICAL = 1,
};
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
enum {
UI_LAYOUT_PANEL = 0,
UI_LAYOUT_HEADER = 1,
UI_LAYOUT_MENU = 2,
UI_LAYOUT_TOOLBAR = 3,
UI_LAYOUT_PIEMENU = 4,
UI_LAYOUT_VERT_BAR = 5,
};
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
UI: Display alpha checkers in image info's color swatch.
2013-12-24 17:20:37 +11:00
#define UI_UNIT_X ((void)0, U.widget_unit)
#define UI_UNIT_Y ((void)0, U.widget_unit)
code cleanup: header cleanup and remove some duplicate defines.
2012-05-12 20:39:39 +00:00
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
enum {
UI_LAYOUT_ALIGN_EXPAND = 0,
UI_LAYOUT_ALIGN_LEFT = 1,
UI_LAYOUT_ALIGN_CENTER = 2,
UI_LAYOUT_ALIGN_RIGHT = 3,
};
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
enum eUI_Item_Flag {
Cleanup: unused enums
2020-02-20 10:21:23 +11:00
/* UI_ITEM_O_RETURN_PROPS = 1 << 0, */ /* UNUSED */
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_ITEM_R_EXPAND = 1 << 1,
UI_ITEM_R_SLIDER = 1 << 2,
UI: support drawing booleans with icons as check-boxes Previously, if a boolean happened to use an icon there was no way to make it display as a check-box from Python scripts. The previous logic meant we ended up having to edit the RNA. Since booleans with icons don't work well with the split-property layout (now used for most of the interface). Icons were being removed from RNA then added back using awkward Python ternary expressions in the interface scripts. The toggle argument now has an unset state (-1). - toggle=True: no checkbox (emboss). - toggle=False: always use a checkbox (no icon). - toggle=(unset/-1): depends on the icon status, default as before. Since toggle=False was default, this isn't used in existing UI logic.
2019-05-21 14:39:09 +10:00
/**
* Use for booleans, causes the button to draw with an outline (emboss),
* instead of text with a checkbox.
* This is implied when toggle buttons have an icon
* unless #UI_ITEM_R_ICON_NEVER flag is set.
*/
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_ITEM_R_TOGGLE = 1 << 3,
UI: support drawing booleans with icons as check-boxes Previously, if a boolean happened to use an icon there was no way to make it display as a check-box from Python scripts. The previous logic meant we ended up having to edit the RNA. Since booleans with icons don't work well with the split-property layout (now used for most of the interface). Icons were being removed from RNA then added back using awkward Python ternary expressions in the interface scripts. The toggle argument now has an unset state (-1). - toggle=True: no checkbox (emboss). - toggle=False: always use a checkbox (no icon). - toggle=(unset/-1): depends on the icon status, default as before. Since toggle=False was default, this isn't used in existing UI logic.
2019-05-21 14:39:09 +10:00
/**
* Don't attempt to use an icon when the icon is set to #ICON_NONE.
*
Cleanup: spelling in comments
2023-08-05 13:46:22 +10:00
* Use for booleans, causes the buttons to always show as a checkbox
UI: support drawing booleans with icons as check-boxes Previously, if a boolean happened to use an icon there was no way to make it display as a check-box from Python scripts. The previous logic meant we ended up having to edit the RNA. Since booleans with icons don't work well with the split-property layout (now used for most of the interface). Icons were being removed from RNA then added back using awkward Python ternary expressions in the interface scripts. The toggle argument now has an unset state (-1). - toggle=True: no checkbox (emboss). - toggle=False: always use a checkbox (no icon). - toggle=(unset/-1): depends on the icon status, default as before. Since toggle=False was default, this isn't used in existing UI logic.
2019-05-21 14:39:09 +10:00
* even when there is an icon (which would normally show the button as a toggle).
*/
UI_ITEM_R_ICON_NEVER = 1 << 4,
UI_ITEM_R_ICON_ONLY = 1 << 5,
UI_ITEM_R_EVENT = 1 << 6,
UI_ITEM_R_FULL_EVENT = 1 << 7,
UI_ITEM_R_NO_BG = 1 << 8,
UI_ITEM_R_IMMEDIATE = 1 << 9,
UI_ITEM_O_DEPRESS = 1 << 10,
UI_ITEM_R_COMPACT = 1 << 11,
UI_ITEM_R_CHECKBOX_INVERT = 1 << 12,
UI: Better split layout support for checkboxes Makes the following layout changes possible: {F8473498} {F8473499} {F8473502} The next commit will contain many layout changes to make good use of these new possibilities. The result should be more consistent, easier to read and should give a more organized impression. Additionally, it should be possible to replace many sub-panels with compacter layouts. Main changes: * Checkboxes now respect the property split layouts * Add support for row and column headers (i.e. `uiLayout.column(heading="Foo")`, `uiLayout.row(heading="Bar")`). If the first property added to this layout doesn't insert anything into the label split column, the heading is inserted there. Otherwise, it's inserted as own item. * Add support for manually inserting decorators for an existing item (`uiLayout.prop_decorator()`). That way layout creators can manually insert this, which was the only way I saw to support property split layouts with a checkbox before the actual property. {F8471883} * Autogenerated layouts for operator properties look bad if there are only checkboxes (which only use half the region width). So before creating the layout, we iterate over visible properties and disable split layout if all are booleans. I think this is fine, if needed we could also add layout hints to operators. * `uiTemplateOperatorPropertyButs()` now handles macros itself, the caller used to be responsible for this. Code that didn't handle these so far never used macros I think, so this change should be invisible. * Remove manual property split layout from autogenerated operator properties layout. * Padding of checkboxes is tweaked to make their label visually more connected to the checkboxes. * Support split layout for menus (should work for `uiLayout.menu()`, `.operator_menu_enum()`, `.prop_menu_enum()`, maybe more) Maniphest Task: https://developer.blender.org/T65965 Differential Revision: https://developer.blender.org/D7427 Reviewed by: Brecht Van Lommel, William Reynish, Pablo Vazques
2020-04-17 16:40:25 +02:00
/** Don't add a real decorator item, just blank space. */
UI_ITEM_R_FORCE_BLANK_DECORATE = 1 << 13,
UI: Add (internal) option to use property splitting for label-less items Usually items without labels don't use the property split layout and just use the full layout width. In some cases that is not wanted because it looks odd if single items within the split layout use the full width. The option is unused but would be needed for adding decorators to the material properties.
2020-04-27 15:24:25 +02:00
/* Even create the property split layout if there's no name to show there. */
UI_ITEM_R_SPLIT_EMPTY_NAME = 1 << 14,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
Cleanup: use typed enum for UI_ITEM_* flags Using an int lead to confusion with other flags often used with buttons. For e.g. these flags could be easily confused with uiItem::flag.
2023-07-29 15:06:33 +10:00
ENUM_OPERATORS(eUI_Item_Flag, UI_ITEM_R_SPLIT_EMPTY_NAME)
#define UI_ITEM_NONE eUI_Item_Flag(0)
2.5: layout.itemO now returns OperatorProperties to be filled in, when passing properties=True as argument. Other changes: * uiItemR, uiItemFullR, uiItemFullO now accept a flag argument rather than multiple different "boolean" arguments, but still exposed as booleans to python. * Fix RNA to support setting PROP_RNAPTR for return values.
2009-08-21 12:57:47 +00:00
UI: increase spacing at sides of headers, to avoid region split zone overlap.
2018-11-20 13:37:31 +01:00
#define UI_HEADER_OFFSET ((void)0, 0.4f * UI_UNIT_X)
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
/* uiLayoutOperatorButs flags */
enum {
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_TEMPLATE_OP_PROPS_SHOW_TITLE = 1 << 0,
UI_TEMPLATE_OP_PROPS_SHOW_EMPTY = 1 << 1,
UI_TEMPLATE_OP_PROPS_COMPACT = 1 << 2,
UI_TEMPLATE_OP_PROPS_HIDE_ADVANCED = 1 << 3,
UI: Better split layout support for checkboxes Makes the following layout changes possible: {F8473498} {F8473499} {F8473502} The next commit will contain many layout changes to make good use of these new possibilities. The result should be more consistent, easier to read and should give a more organized impression. Additionally, it should be possible to replace many sub-panels with compacter layouts. Main changes: * Checkboxes now respect the property split layouts * Add support for row and column headers (i.e. `uiLayout.column(heading="Foo")`, `uiLayout.row(heading="Bar")`). If the first property added to this layout doesn't insert anything into the label split column, the heading is inserted there. Otherwise, it's inserted as own item. * Add support for manually inserting decorators for an existing item (`uiLayout.prop_decorator()`). That way layout creators can manually insert this, which was the only way I saw to support property split layouts with a checkbox before the actual property. {F8471883} * Autogenerated layouts for operator properties look bad if there are only checkboxes (which only use half the region width). So before creating the layout, we iterate over visible properties and disable split layout if all are booleans. I think this is fine, if needed we could also add layout hints to operators. * `uiTemplateOperatorPropertyButs()` now handles macros itself, the caller used to be responsible for this. Code that didn't handle these so far never used macros I think, so this change should be invisible. * Remove manual property split layout from autogenerated operator properties layout. * Padding of checkboxes is tweaked to make their label visually more connected to the checkboxes. * Support split layout for menus (should work for `uiLayout.menu()`, `.operator_menu_enum()`, `.prop_menu_enum()`, maybe more) Maniphest Task: https://developer.blender.org/T65965 Differential Revision: https://developer.blender.org/D7427 Reviewed by: Brecht Van Lommel, William Reynish, Pablo Vazques
2020-04-17 16:40:25 +02:00
/* Disable property split for the default layout (custom ui callbacks still have full control
* over the layout and can enable it). */
UI_TEMPLATE_OP_PROPS_NO_SPLIT_LAYOUT = 1 << 4,
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
};
Centralized operator UI drawing into a new function uiLayoutOperatorButs(), Operator drawing calls were duplicated in file selector panel, redo panels, redo & dialog popups. note, uiDefAutoButsRNA's column's argument was misleading, renamed to label_align.
2010-12-15 05:42:23 +00:00
Cleanup: corrections, clarification to do comments
2023-01-20 15:20:02 +11:00
/* Used for transparent checkers shown under color buttons that have an alpha component. */
UI: Display alpha checkers in image info's color swatch.
2013-12-24 17:20:37 +11:00
#define UI_ALPHA_CHECKER_DARK 100
#define UI_ALPHA_CHECKER_LIGHT 160
replace magic numbers for flags for uiSetRoundBox();
2011-09-11 06:41:09 +00:00
/* flags to set which corners will become rounded:
*
* 1------2
* | |
* 8------4 */
enum {
Cleanup: move comments above definitions, use enum For clang-format not to wrap definitions.
2019-01-14 15:58:40 +11:00
UI_CNR_TOP_LEFT = 1 << 0,
UI_CNR_TOP_RIGHT = 1 << 1,
UI_CNR_BOTTOM_RIGHT = 1 << 2,
UI_CNR_BOTTOM_LEFT = 1 << 3,
replace magic numbers for flags for uiSetRoundBox();
2011-09-11 06:41:09 +00:00
/* just for convenience */
Use bit-shift op for all bit-flags. Btw, there is a comment stating that bits 12-15 are the same for uiBlock->flag and uiBut->flag, this is obviously no more true currently (maybe it is now bits 14-17, i.e. ALIGN flags?).
2013-06-25 10:30:07 +00:00
UI_CNR_NONE = 0,
Cleanup: commas at the end of enums Without this clang-format may wrap them onto a single line.
2019-01-15 23:57:49 +11:00
UI_CNR_ALL = (UI_CNR_TOP_LEFT | UI_CNR_TOP_RIGHT | UI_CNR_BOTTOM_RIGHT | UI_CNR_BOTTOM_LEFT),
replace magic numbers for flags for uiSetRoundBox();
2011-09-11 06:41:09 +00:00
};
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
uiLayout *UI_block_layout(uiBlock *block,
int dir,
int type,
int x,
int y,
int size,
int em,
int padding,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const uiStyle *style);
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_block_layout_set_current(uiBlock *block, uiLayout *layout);
Cleanup: return argument naming
2019-03-25 12:19:55 +11:00
void UI_block_layout_resolve(uiBlock *block, int *r_x, int *r_y);
Fix T94316: Asset catalog tree scrolls away when renaming a catalog The activation of the text button is a bit special, since it happens during drawing, the layout isn't computed yet then. Comparable cases where the button is added on top don't use the layout system, so this didn't become an issue until now. Trigger a delayed call to `UI_but_ensure_in_view()`.
2022-01-03 19:20:00 +01:00
bool UI_block_layout_needs_resolving(const uiBlock *block);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Used for property search when the layout process needs to be cancelled in order to avoid
* computing the locations for buttons, but the layout items created while adding the buttons
* must still be freed.
*/
Property Search: Find results in all tabs This patch enables property search for all tabs in the property editor. To make interaction faster, if the editor's current tab doesn't have a result, the current tab changes to the next tab that has a match. This patch implements basic code that only searches panels. While we could run the existing "single tab" property search for every tab, that would also do everything else related to the layout pass, which would be less efficient, and maybe more complicated to maintain. The search match status for every current tab of the property editor is stored in a runtime bitfield and them displayed later by dimming icons in the tab selector panel to the left. Using `BLI_bitmap` properly in the runtime struct required moving it to `buttons_intern.h` and adding a small API to access the search filter instead. To make sure the editor isn't influenced by anything that happens while building the layout for other tabs, most of the context is duplicated and the new search is run in the duplicated editor. Note that the tool settings tab works slightly different than the other tabs, so I've disabled searching it for this commit. That would be a relatively simple improvement, but would just require a bit of refactoring of existing code. Differential Revision: https://developer.blender.org/D8859
2020-10-13 13:10:41 -05:00
void UI_block_layout_free(uiBlock *block);
2.5: UI Layout Engine, initial code. * As a test, used by: * Object buttons, tried to make it match the mockup. * Text window header. * Text window properties panel. * Panel interaction with view2d is still problematic, need to make this work properly still. * Templates are very basic, the ones there are simple but already can follow the object buttons mockup quite closely. * It's based on a three level system: panels, templates and items. To get an idea of what that means in practice, see: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/UI_LayoutEngine#Panels.2C_Templates_and_Items
2009-03-13 13:38:41 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Apply property search behavior, setting panel flags and deactivating buttons that don't match.
*
* \note Must not be run after #UI_block_layout_resolve.
*/
Cleanup: Remove unecessary storage of search filter in uiBlock Since the search is applied all in one phase, there is no need to store a reference to the search filter in every uiBlock. Instead just pass it as an argument to UI_block_apply_search_filter.
2020-09-24 11:22:30 -05:00
bool UI_block_apply_search_filter(uiBlock *block, const char *search_filter);
UI: Single tab property search This adds a search bar to the properties editor. The full search for every tab isn't included in this patch, but the interaction with panels, searching behavior, UI, region level, and DNA changes are included here. The block-level search works by iterating over the block's button groups and checking whether they match the search. If they do, they are tagged with a flag, and the block's panel is tagged too. For every update (text edit), the panel's expansion is set to whether the panel has a result or not. The search also checks for matching strings inside enums and in panel labels. One complication to this that isn't immediately apparent is that closed panel's subpanels have to be searched too. This adds some complexity to the area-level panel layout code. Possible Future Improvements: - Use the new fuzzy search in BLI - Reset panels to their expansion before the search started if the user escape out of the text box. - Open all child panels of a panel with expansion. Differential Revision: https://developer.blender.org/D8856
2020-09-15 11:25:49 -05:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_region_message_subscribe(ARegion *region, wmMsgBus *mbus);
WM: message bus replacement for property notifiers Use dynamically generated message publish/subscribe so buttons and manipulators update properly. This resolves common glitches where manipulators weren't updating as well as the UI when add-ons exposed properties which hard coded listeners weren't checking for. Python can also publish/scribe changes via `bpy.msgbus`. See D2917
2017-11-13 19:43:34 +11:00
UI: * Added some properties of uiLayout that can be set. I've added some API code for more than the two I've implementeds, so ignore those for now. * layout.active = False will gray out buttons inside a layout. * layout.enabled = False will gray out and completely disable the buttons inside a layout. * Also some function renames.
2009-05-28 23:37:55 +00:00
uiBlock *uiLayoutGetBlock(uiLayout *layout);
UI * Headers and menus can now be created in python. * Replaced the uiMenuItem functions to create menus with equivalent uiItem functions using a layout, removing duplicated code. * More uiItem functions are now exposed to python. * The text editor header, panels and one of its menus are now created in space_text.py. * Buttons window data context icon new changes depending on active object. Issues * Icons are not wrapped yet, hardcoded ints at the moment. * The ID browse template is unfinished.
2009-04-22 18:39:44 +00:00
UI: * Added some properties of uiLayout that can be set. I've added some API code for more than the two I've implementeds, so ignore those for now. * layout.active = False will gray out buttons inside a layout. * layout.enabled = False will gray out and completely disable the buttons inside a layout. * Also some function renames.
2009-05-28 23:37:55 +00:00
void uiLayoutSetFunc(uiLayout *layout, uiMenuHandleFunc handlefunc, void *argv);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiLayoutSetContextPointer(uiLayout *layout, const char *name, PointerRNA *ptr);
bContextStore *uiLayoutGetContextStore(uiLayout *layout);
Cleanup: Use const for context store variables Generally the context store is owned by `uiBlock`. Other pointers to the store (in `bContext` and other operator data) shouldn't change it, so those variables are now const. One exception is the pointer in `uiLayout`, but that has a clearly short lifetime, so that's okay.
2023-08-31 11:59:58 -04:00
void uiLayoutContextCopy(uiLayout *layout, const bContextStore *context);
UI: Add support for showing socket descriptions in tooltips Currently, hovering over a socket itself shows no tooltip at all, while hovering over its value field shows "Default value", which is not helpful. This patch therefore implements socket tooltips following the proposal at https://blender.community/c/rightclickselect/2Qgbbc/. A lot of the basic functionality was already implemented for Geometry Nodes, where hovering over the socket itself shows introspection info. This patch extends this by: - Supporting dynamic tooltips on labels, which is important for good tooltip coverage in a socket's region of the node. - Adding a function to setting a dynamic tooltip for an entire uiLayout, which avoids needing to set it manually for a wide variety of socket types. - Hiding the property label field in a tooltip when dynamic tooltip is also provided. If really needed, this label can be restored through the dynamic tooltip, but in all current cases the label is actually pointless anyways since the dynamic tooltip gives more accurate and specific information. - Adding dynamic tooltips to a socket's UI layout row if it has a description configured, both in the Node Editor as well as in the Material Properties. Note that the patch does not add any actual tooltip content yet, just the infrastructure to show them. By default, sockets without a description still show the old "Default value" tooltip. For an example of how to add socket descriptions, check the Cylinder node in the Geometry Nodes. Differential Revision: https://developer.blender.org/D9967
2022-04-11 02:02:12 +02:00
/**
* Set tooltip function for all buttons in the layout.
* func, arg and free_arg are passed on to UI_but_func_tooltip_set, so their meaning is the same.
*
* \param func: The callback function that gets called to get tooltip content
* \param arg: An optional opaque pointer that gets passed to func
* \param free_arg: An optional callback for freeing arg (can be set to e.g. MEM_freeN)
* \param copy_arg: An optional callback for duplicating arg in case UI_but_func_tooltip_set
* is being called on multiple buttons (can be set to e.g. MEM_dupallocN). If set to NULL, arg will
* be passed as-is to all buttons.
*/
void uiLayoutSetTooltipFunc(uiLayout *layout,
uiButToolTipFunc func,
void *arg,
uiCopyArgFunc copy_arg,
uiFreeArgFunc free_arg);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* This is a bit of a hack but best keep it in one place at least.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperatorType *UI_but_operatortype_get_from_enum_menu(uiBut *but, PropertyRNA **r_prop);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* This is a bit of a hack but best keep it in one place at least.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
MenuType *UI_but_menutype_get(uiBut *but);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* This is a bit of a hack but best keep it in one place at least.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PanelType *UI_but_paneltype_get(uiBut *but);
void UI_menutype_draw(bContext *C, MenuType *mt, uiLayout *layout);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Used for popup panels only.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_paneltype_draw(bContext *C, PanelType *pt, uiLayout *layout);
UI: use button_operator in operator_menu_hold Move draw calls into UI_menutype_draw
2017-11-02 18:19:11 +11:00
/* Only for convenience. */
void uiLayoutSetContextFromBut(uiLayout *layout, uiBut *but);
Context: Added a system for adding a "local" context in a UI layout. This way you can define for example within a modifier panel all operators to get the modifier in the context. In the layout code: uiLayoutSetContextPointer(layout, "modifier", &ptr) layout.set_context_pointer("modifier", md) In the operator: ptr = CTX_data_pointer_get(C, "modifier") md = context.modifier
2009-05-28 23:13:42 +00:00
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
void uiLayoutSetOperatorContext(uiLayout *layout, wmOperatorCallContext opcontext);
code cleanup: use bools in UI and WM code, quiet some shadow warnings, remove unused function uiEmboss()
2013-04-04 02:05:11 +00:00
void uiLayoutSetActive(uiLayout *layout, bool active);
UI: support an 'active default' button for pop-ups Use this for the save confirmation dialog so it has a default action when pressing enter which draws with a highlight so it's clear what the default action is (the dialog was just closing before). Resolves T57686
2019-03-27 21:39:44 +11:00
void uiLayoutSetActiveDefault(uiLayout *layout, bool active_default);
Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes
2020-09-04 20:59:13 +02:00
void uiLayoutSetActivateInit(uiLayout *layout, bool activate_init);
code cleanup: use bools in UI and WM code, quiet some shadow warnings, remove unused function uiEmboss()
2013-04-04 02:05:11 +00:00
void uiLayoutSetEnabled(uiLayout *layout, bool enabled);
void uiLayoutSetRedAlert(uiLayout *layout, bool redalert);
void uiLayoutSetAlignment(uiLayout *layout, char alignment);
UI: layout support for fixed size buttons, and use for file browser open/cancel Not exposed to Python API yet, this should get more detailed testing with different layouts before that happens. Ref T69652
2019-09-19 16:14:47 +02:00
void uiLayoutSetFixedSize(uiLayout *layout, bool fixed_size);
code cleanup: use bools in UI and WM code, quiet some shadow warnings, remove unused function uiEmboss()
2013-04-04 02:05:11 +00:00
void uiLayoutSetKeepAspect(uiLayout *layout, bool keepaspect);
UI: * Implemented scale_x/scale_y for layouts. * Implemented left/right/center/expand alignment for row layouts.
2009-06-03 00:04:48 +00:00
void uiLayoutSetScaleX(uiLayout *layout, float scale);
void uiLayoutSetScaleY(uiLayout *layout, float scale);
UI: allow fractical unit size for layouts.
2018-09-26 17:44:35 +02:00
void uiLayoutSetUnitsX(uiLayout *layout, float unit);
void uiLayoutSetUnitsY(uiLayout *layout, float unit);
Cleanup: Use typedef for UI emboss type enum Previously both `char` and `int` were used to represent this enum. Differential Revision: https://developer.blender.org/D9903
2020-12-19 10:07:13 -06:00
void uiLayoutSetEmboss(uiLayout *layout, eUIEmbossType emboss);
UI: Option to layout properties in two columns Needed for proposed alternate layout, see T54951.
2018-05-28 16:40:27 +02:00
void uiLayoutSetPropSep(uiLayout *layout, bool is_sep);
UI: Add property decorator buttons When use_property_split is enabled, this template adds buttons to set keyframes, (Alternative to showing color). See: T54951
2018-06-16 14:48:21 +02:00
void uiLayoutSetPropDecorate(uiLayout *layout, bool is_sep);
UI: add UILayout.direction Read only attribute, needed for introspection.
2018-12-20 11:59:31 +11:00
int uiLayoutGetLocalDir(const uiLayout *layout);
UI: * Added some properties of uiLayout that can be set. I've added some API code for more than the two I've implementeds, so ignore those for now. * layout.active = False will gray out buttons inside a layout. * layout.enabled = False will gray out and completely disable the buttons inside a layout. * Also some function renames.
2009-05-28 23:37:55 +00:00
Cleanup: Move UI RNA files to C++ See #103343 Pull Request: https://projects.blender.org/blender/blender/pulls/109090
2023-06-18 01:39:21 +02:00
wmOperatorCallContext uiLayoutGetOperatorContext(uiLayout *layout);
code cleanup: use bools in UI and WM code, quiet some shadow warnings, remove unused function uiEmboss()
2013-04-04 02:05:11 +00:00
bool uiLayoutGetActive(uiLayout *layout);
UI: support an 'active default' button for pop-ups Use this for the save confirmation dialog so it has a default action when pressing enter which draws with a highlight so it's clear what the default action is (the dialog was just closing before). Resolves T57686
2019-03-27 21:39:44 +11:00
bool uiLayoutGetActiveDefault(uiLayout *layout);
UI: support for popups starting with buttons activated While this could already be done from C, this is now exposed to Python
2019-03-20 22:40:38 +11:00
bool uiLayoutGetActivateInit(uiLayout *layout);
code cleanup: use bools in UI and WM code, quiet some shadow warnings, remove unused function uiEmboss()
2013-04-04 02:05:11 +00:00
bool uiLayoutGetEnabled(uiLayout *layout);
bool uiLayoutGetRedAlert(uiLayout *layout);
UI: * Added some properties of uiLayout that can be set. I've added some API code for more than the two I've implementeds, so ignore those for now. * layout.active = False will gray out buttons inside a layout. * layout.enabled = False will gray out and completely disable the buttons inside a layout. * Also some function renames.
2009-05-28 23:37:55 +00:00
int uiLayoutGetAlignment(uiLayout *layout);
UI: layout support for fixed size buttons, and use for file browser open/cancel Not exposed to Python API yet, this should get more detailed testing with different layouts before that happens. Ref T69652
2019-09-19 16:14:47 +02:00
bool uiLayoutGetFixedSize(uiLayout *layout);
code cleanup: use bools in UI and WM code, quiet some shadow warnings, remove unused function uiEmboss()
2013-04-04 02:05:11 +00:00
bool uiLayoutGetKeepAspect(uiLayout *layout);
2.5 Flaw in python UI for headers: code missing to correctly set the total width of header, plus obsolete call in view3d header template to set width. Now MMB scroll of view3d header works again.
2009-08-16 13:01:40 +00:00
int uiLayoutGetWidth(uiLayout *layout);
UI: * Implemented scale_x/scale_y for layouts. * Implemented left/right/center/expand alignment for row layouts.
2009-06-03 00:04:48 +00:00
float uiLayoutGetScaleX(uiLayout *layout);
float uiLayoutGetScaleY(uiLayout *layout);
UI: allow fractical unit size for layouts.
2018-09-26 17:44:35 +02:00
float uiLayoutGetUnitsX(uiLayout *layout);
float uiLayoutGetUnitsY(uiLayout *layout);
Cleanup: Use typedef for UI emboss type enum Previously both `char` and `int` were used to represent this enum. Differential Revision: https://developer.blender.org/D9903
2020-12-19 10:07:13 -06:00
eUIEmbossType uiLayoutGetEmboss(uiLayout *layout);
UI: Option to layout properties in two columns Needed for proposed alternate layout, see T54951.
2018-05-28 16:40:27 +02:00
bool uiLayoutGetPropSep(uiLayout *layout);
UI: Add property decorator buttons When use_property_split is enabled, this template adds buttons to set keyframes, (Alternative to showing color). See: T54951
2018-06-16 14:48:21 +02:00
bool uiLayoutGetPropDecorate(uiLayout *layout);
UI: * Added some properties of uiLayout that can be set. I've added some API code for more than the two I've implementeds, so ignore those for now. * layout.active = False will gray out buttons inside a layout. * layout.enabled = False will gray out and completely disable the buttons inside a layout. * Also some function renames.
2009-05-28 23:37:55 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/* Layout create functions. */
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
uiLayout *uiLayoutRow(uiLayout *layout, bool align);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* See #uiLayoutColumnWithHeading().
*/
UI: Better split layout support for checkboxes Makes the following layout changes possible: {F8473498} {F8473499} {F8473502} The next commit will contain many layout changes to make good use of these new possibilities. The result should be more consistent, easier to read and should give a more organized impression. Additionally, it should be possible to replace many sub-panels with compacter layouts. Main changes: * Checkboxes now respect the property split layouts * Add support for row and column headers (i.e. `uiLayout.column(heading="Foo")`, `uiLayout.row(heading="Bar")`). If the first property added to this layout doesn't insert anything into the label split column, the heading is inserted there. Otherwise, it's inserted as own item. * Add support for manually inserting decorators for an existing item (`uiLayout.prop_decorator()`). That way layout creators can manually insert this, which was the only way I saw to support property split layouts with a checkbox before the actual property. {F8471883} * Autogenerated layouts for operator properties look bad if there are only checkboxes (which only use half the region width). So before creating the layout, we iterate over visible properties and disable split layout if all are booleans. I think this is fine, if needed we could also add layout hints to operators. * `uiTemplateOperatorPropertyButs()` now handles macros itself, the caller used to be responsible for this. Code that didn't handle these so far never used macros I think, so this change should be invisible. * Remove manual property split layout from autogenerated operator properties layout. * Padding of checkboxes is tweaked to make their label visually more connected to the checkboxes. * Support split layout for menus (should work for `uiLayout.menu()`, `.operator_menu_enum()`, `.prop_menu_enum()`, maybe more) Maniphest Task: https://developer.blender.org/T65965 Differential Revision: https://developer.blender.org/D7427 Reviewed by: Brecht Van Lommel, William Reynish, Pablo Vazques
2020-04-17 16:40:25 +02:00
uiLayout *uiLayoutRowWithHeading(uiLayout *layout, bool align, const char *heading);
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
uiLayout *uiLayoutColumn(uiLayout *layout, bool align);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Variant of #uiLayoutColumn() that sets a heading label for the layout if the first item is
* added through #uiItemFullR(). If split layout is used and the item has no string to add to the
* first split-column, the heading is added there instead. Otherwise the heading inserted with a
* new row.
*/
UI: Better split layout support for checkboxes Makes the following layout changes possible: {F8473498} {F8473499} {F8473502} The next commit will contain many layout changes to make good use of these new possibilities. The result should be more consistent, easier to read and should give a more organized impression. Additionally, it should be possible to replace many sub-panels with compacter layouts. Main changes: * Checkboxes now respect the property split layouts * Add support for row and column headers (i.e. `uiLayout.column(heading="Foo")`, `uiLayout.row(heading="Bar")`). If the first property added to this layout doesn't insert anything into the label split column, the heading is inserted there. Otherwise, it's inserted as own item. * Add support for manually inserting decorators for an existing item (`uiLayout.prop_decorator()`). That way layout creators can manually insert this, which was the only way I saw to support property split layouts with a checkbox before the actual property. {F8471883} * Autogenerated layouts for operator properties look bad if there are only checkboxes (which only use half the region width). So before creating the layout, we iterate over visible properties and disable split layout if all are booleans. I think this is fine, if needed we could also add layout hints to operators. * `uiTemplateOperatorPropertyButs()` now handles macros itself, the caller used to be responsible for this. Code that didn't handle these so far never used macros I think, so this change should be invisible. * Remove manual property split layout from autogenerated operator properties layout. * Padding of checkboxes is tweaked to make their label visually more connected to the checkboxes. * Support split layout for menus (should work for `uiLayout.menu()`, `.operator_menu_enum()`, `.prop_menu_enum()`, maybe more) Maniphest Task: https://developer.blender.org/T65965 Differential Revision: https://developer.blender.org/D7427 Reviewed by: Brecht Van Lommel, William Reynish, Pablo Vazques
2020-04-17 16:40:25 +02:00
uiLayout *uiLayoutColumnWithHeading(uiLayout *layout, bool align, const char *heading);
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
uiLayout *uiLayoutColumnFlow(uiLayout *layout, int number, bool align);
Add new GridFlow layout. This mimics the 'spreadsheet' behavior. Columns and/or rows can have equal sizes, or adapt to their content - but always in a grid way (i.e. all items in a same column will always have same available width, and all items in a same row will always have same available height). Also, you can fill (order) the grid in a row- or column-major way. Not used anywhere for now. Differential: https://developer.blender.org/D2395
2018-06-09 16:50:05 +02:00
uiLayout *uiLayoutGridFlow(uiLayout *layout,
Merge branch 'master' into blender2.8
2018-07-01 16:22:06 +02:00
bool row_major,
int columns_len,
bool even_columns,
bool even_rows,
bool align);
UI: * Don't call generic layout hints templates anymore, i.e. TemplateRow becomes Row, etc. * Added more general layout nesting, using uiLayoutSplit() and uiLayoutBox() functions, for which the sublayouts can then be accessed using uiLayoutSub(), to put items in those sublayouts. * Some steps to make the layout decisions, like which items to put in which columns, independent of the width of the window or the text in the buttons. We want the layout to be stable under resizes and translations. * Added an "expand" parameter to uiItemR, used now to expand enums into a row instead of using a menu.
2009-04-16 12:17:58 +00:00
uiLayout *uiLayoutBox(uiLayout *layout);
Cleanup: right shift
2018-07-09 06:38:07 +02:00
uiLayout *uiLayoutListBox(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiList *ui_list,
PointerRNA *actptr,
PropertyRNA *actprop);
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
uiLayout *uiLayoutAbsolute(uiLayout *layout, bool align);
uiLayout *uiLayoutSplit(uiLayout *layout, float percentage, bool align);
UI: List Template tweaks to get it a bit more usable * Mouse wheel now scrolls the list. * Up/down key and alt mouse wheel change the active item. * Adding/removing items from the list now automatically scrolls so the active item is in the view. * Shift mouse wheel changes the size of the list widget to display more items. Lazy replacement for a proper grip. * Shape key list now displays the influence value next to the name, * Also fix the range of the value slider to match the defined min/max range.
2009-10-21 20:58:10 +00:00
uiLayout *uiLayoutOverlap(uiLayout *layout);
3D View panels now show object and bone name again, not sure it belongs here still, but this came up often, it avoids having to switch tabs a lot when creating things. Also renamed uiLayoutFreeBlock to uiLayoutAbsoluteBlock.
2009-10-09 10:45:11 +00:00
uiBlock *uiLayoutAbsoluteBlock(uiLayout *layout);
Pie Menus C code backend. This commit merges the code in the pie-menu branch. As per decisions taken the last few days, there are no pie menus included and there will be an official add-on including overrides of some keys with pie menus. However, people will now be able to use the new code in python. Full Documentation is in http://wiki.blender.org/index.php/Dev:Ref/ Thanks: Campbell Barton, Dalai Felinto and Ton Roosendaal for the code review and design comments Jonathan Williamson, Pawel Lyczkowski, Pablo Vazquez among others for suggestions during the development. Special Thanks to Sean Olson, for his support, suggestions, testing and merciless bugging so that I would finish the pie menu code. Without him we wouldn't be here. Also to the rest of the developers of the original python add-on, Patrick Moore and Dan Eicher and finally to Matt Ebb, who did the research and first implementation and whose code I used to get started.
2014-08-11 10:39:59 +02:00
uiLayout *uiLayoutRadial(uiLayout *layout);
UI * Fix buttons jumping around when resizing and zoom. Part of this was adding a tiny a 0.001f offset in UI_view2d_view_ortho, otherwise the rounding is unpredictable (used to be 0.375f, but that was disabled). * Fix various issues with zooming, panning panels. V2D_LOCKOFS_X/Y is now taken into account in more places in the view2d code, to avoid zooming into the center or panning out of the view. * Remove "Free" align mode in buttons window (it's not really useful). * View3D/Graph/Image editors now use the same PanelType system as the buttons window, means some deprecated panel code could be removed. * Some small visual tweaks for panels. * View 2D Reset operator (Home key), to reset zoom and panning for panels. * Added argument to set number buttons as sliders (slider=True for itemR). * Ignore labels for button alignment (doesn't look right). * Fix some use of context.main in py scripts, should get data from active object instead. * Fix autotexspace -> auto_texspace in py script.
2009-05-19 17:13:33 +00:00
UI: * Don't call generic layout hints templates anymore, i.e. TemplateRow becomes Row, etc. * Added more general layout nesting, using uiLayoutSplit() and uiLayoutBox() functions, for which the sublayouts can then be accessed using uiLayoutSub(), to put items in those sublayouts. * Some steps to make the layout decisions, like which items to put in which columns, independent of the width of the window or the text in the buttons. We want the layout to be stable under resizes and translations. * Added an "expand" parameter to uiItemR, used now to expand enums into a row instead of using a menu.
2009-04-16 12:17:58 +00:00
/* templates */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateHeader(uiLayout *layout, bContext *C);
Fix T53632: Objects outside scene shown in popup Only show objects in current scene when not pinned. This commit adds a filter argument to id-template since we may want to filter by other criteria.
2018-01-03 21:54:02 +11:00
void uiTemplateID(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const bContext *C,
PointerRNA *ptr,
Fix T53632: Objects outside scene shown in popup Only show objects in current scene when not pinned. This commit adds a filter argument to id-template since we may want to filter by other criteria.
2018-01-03 21:54:02 +11:00
const char *propname,
New Grease Pencil object for 2D animation This commit merge the full development done in greasepencil-object branch and include mainly the following features. - New grease pencil object. - New drawing engine. - New grease pencil modes Draw/Sculpt/Edit and Weight Paint. - New brushes for grease pencil. - New modifiers for grease pencil. - New shaders FX. - New material system (replace old palettes and colors). - Split of annotations (old grease pencil) and new grease pencil object. - UI adapted to blender 2.8. You can get more info here: https://code.blender.org/2017/12/drawing-2d-animation-in-blender-2-8/ https://code.blender.org/2018/07/grease-pencil-status-update/ This is the result of nearly two years of development and I want thanks firstly the other members of the grease pencil team: Daniel M. Lara, Matias Mendiola and Joshua Leung for their support, ideas and to keep working in the project all the time, without them this project had been impossible. Also, I want thanks other Blender developers for their help, advices and to be there always to help me, and specially to Clément Foucault, Dalai Felinto, Pablo Vázquez and Campbell Barton.
2018-07-31 10:22:19 +02:00
const char *newop,
const char *openop,
const char *unlinkop,
Cleanup: style, duplicate includes
2018-07-31 20:11:55 +10:00
int filter,
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
bool live_icon,
UI: Allow label for Template-ID (respecting property split layout) Adds a `text` parameter to `bpy.types.uiLayout.template_ID()` which causes a label to be added, as usual. Adding the label also makes the template respect the `bpy.types.uiLayout.use_property_split` option. Also fixes wrong layout being used in the template-ID, although I think that didn't cause issues in practice. Sergey requested this for usage in the Movie Clip Editor.
2019-11-25 19:41:30 +01:00
const char *text);
Fix T53632: Objects outside scene shown in popup Only show objects in current scene when not pinned. This commit adds a filter argument to id-template since we may want to filter by other criteria.
2018-01-03 21:54:02 +11:00
void uiTemplateIDBrowse(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bContext *C,
PointerRNA *ptr,
Fix T53632: Objects outside scene shown in popup Only show objects in current scene when not pinned. This commit adds a filter argument to id-template since we may want to filter by other criteria.
2018-01-03 21:54:02 +11:00
const char *propname,
const char *newop,
const char *openop,
const char *unlinkop,
UI: Allow label for Template-ID (respecting property split layout) Adds a `text` parameter to `bpy.types.uiLayout.template_ID()` which causes a label to be added, as usual. Adding the label also makes the template respect the `bpy.types.uiLayout.use_property_split` option. Also fixes wrong layout being used in the template-ID, although I think that didn't cause issues in practice. Sergey requested this for usage in the Movie Clip Editor.
2019-11-25 19:41:30 +01:00
int filter,
const char *text);
Fix T53632: Objects outside scene shown in popup Only show objects in current scene when not pinned. This commit adds a filter argument to id-template since we may want to filter by other criteria.
2018-01-03 21:54:02 +11:00
void uiTemplateIDPreview(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bContext *C,
PointerRNA *ptr,
Fix T53632: Objects outside scene shown in popup Only show objects in current scene when not pinned. This commit adds a filter argument to id-template since we may want to filter by other criteria.
2018-01-03 21:54:02 +11:00
const char *propname,
Add hide_buttons option to template_ID_preview When use the template in the topbar for only select an ID is very annoying to have the buttons after the name and only adds noise to the selector. This option hide the number of users, new and delete buttons to get a cleaner topbar selector. By default the parameter is disabled in order to keep all existing code/UI running.
2018-11-02 17:30:09 +01:00
const char *newop,
const char *openop,
const char *unlinkop,
int rows,
int cols,
Cleanup: style
2018-11-03 15:55:33 +11:00
int filter,
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
bool hide_buttons);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Version of #uiTemplateID using tabs.
*/
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
void uiTemplateIDTabs(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bContext *C,
PointerRNA *ptr,
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
const char *propname,
Application Templates: make templates more prominent in the UI. The goal here is to make app templates usable for default templates that we can ship with Blender. These only have a custom startup.blend currently and so are quite limited compared to app templates that fully customize Blender. But still it seems like the same kind of concept where we should be sharing the code and UI. It is useful to be able to save a startup.blend per template, and I can imagine some scripting being useful in the future as well. Changes made: * File > New and Ctrl+N now list the templates, replacing a separate Application Templates menu that was not as easy to discover. * File menu now shows name of active template above Save Startup File and Load Factory Settings to indicate these are saved/loaded per template. * The "Default" template was renamed to "General". * Workspaces can now be added from any of the template startup.blend files when clicking the (+) button in the topbar. * User preferences are now fully shared between app templates, unless the template includes a custom userpref.blend. I think this will be useful in general, not all app templates need their own keymaps for example. * Previously Save User Preferences would save the current app template and then Blender would start using that template by default. I've disabled this, to me it seems it was unintentional, or at least not clear at all that saving user preferences also makes the current Differential Revision: https://developer.blender.org/D3690
2018-08-28 15:12:14 +02:00
const char *newop,
const char *menu,
UI: New Global Top-Bar (WIP) == Main Features/Changes for Users * Add horizontal bar at top of all non-temp windows, consisting out of two horizontal sub-bars. * Upper sub-bar contains global menus (File, Render, etc.), tabs for workspaces and scene selector. * Lower sub-bar contains object mode selector, screen-layout and render-layer selector. Later operator and/or tool settings will be placed here. * Individual sections of the topbar are individually scrollable. * Workspace tabs can be double- or ctrl-clicked for renaming and contain 'x' icon for deleting. * Top-bar should scale nicely with DPI. * The lower half of the top-bar can be hided by dragging the lower top-bar edge up. Better hiding options are planned (e.g. hide in fullscreen modes). * Info editors at the top of the window and using the full window width with be replaced by the top-bar. * In fullscreen modes, no more info editor is added on top, the top-bar replaces it. == Technical Features/Changes * Adds initial support for global areas A global area is part of the window, not part of the regular screen-layout. I've added a macro iterator to iterate over both, global and screen-layout level areas. When iterating over areas, from now on developers should always consider if they have to include global areas. * Adds a TOPBAR editor type The editor type is hidden in the UI editor type menu. * Adds a variation of the ID template to display IDs as tab buttons (template_ID_tabs in BPY) * Does various changes to RNA button creation code to improve their appearance in the horizontal top-bar. * Adds support for dynamically sized regions. That is, regions that scale automatically to the layout bounds. The code for this is currently a big hack (it's based on drawing the UI multiple times). This should definitely be improved. * Adds a template for displaying operator properties optimized for the top-bar. This will probably change a lot still and is in fact disabled in code. Since the final top-bar design depends a lot on other 2.8 designs (mainly tool-system and workspaces), we decided to not show the operator or tool settings in the top-bar for now. That means most of the lower sub-bar is empty for the time being. NOTE: Top-bar or global area data is not written to files or SDNA. They are simply added to the window when opening Blender or reading a file. This allows us doing changes to the top-bar without having to care for compatibility. == ToDo's It's a bit hard to predict all the ToDo's here are the known main ones: * Add options for the new active-tool system and for operator redo to the topbar. * Automatically hide the top-bar in fullscreen modes. * General visual polish. * Top-bar drag & drop support (WIP in temp-tab_drag_drop). * Improve dynamic regions (should also fix some layout glitches). * Make internal terminology consistent. * Enable topbar file writing once design is more advanced. * Address TODO's and XXX's in code :) Thanks @brecht for the review! And @sergey for the complaining ;) Differential Revision: D2758
2018-04-20 17:14:03 +02:00
int filter);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* This is for selecting the type of ID-block to use,
* and then from the relevant type choosing the block to use.
*
* \param propname: property identifier for property that ID-pointer gets stored to.
* \param proptypename: property identifier for property
* used to determine the type of ID-pointer that can be used.
*/
Cleanup: right shift
2018-07-09 06:38:07 +02:00
void uiTemplateAnyID(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const char *propname,
const char *proptypename,
const char *text);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Search menu to pick an item from a collection.
* A version of uiTemplateID that works for non-ID types.
*/
UI: Add template_search (version of template_ID for non-IDs) Adds a version of template_ID that can be used for non-ID properties. The property to search for and the collection to search in has to be passed to it. Like template_ID it also takes arguments to define a 'new' and 'unlink' operator. They will be displayed as icon-only buttons then. Also added a version that can display preview thumbnails. Had to do some additional changes to make text-buttons support displaying/modifying empty RNA properties. This will be needed for workspaces, see D2451. Reviewed By: campbellbarton Differential Revision: https://developer.blender.org/D2666
2017-05-12 01:42:42 +02:00
void uiTemplateSearch(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bContext *C,
PointerRNA *ptr,
UI: Add template_search (version of template_ID for non-IDs) Adds a version of template_ID that can be used for non-ID properties. The property to search for and the collection to search in has to be passed to it. Like template_ID it also takes arguments to define a 'new' and 'unlink' operator. They will be displayed as icon-only buttons then. Also added a version that can display preview thumbnails. Had to do some additional changes to make text-buttons support displaying/modifying empty RNA properties. This will be needed for workspaces, see D2451. Reviewed By: campbellbarton Differential Revision: https://developer.blender.org/D2666
2017-05-12 01:42:42 +02:00
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *searchptr,
UI: Add template_search (version of template_ID for non-IDs) Adds a version of template_ID that can be used for non-ID properties. The property to search for and the collection to search in has to be passed to it. Like template_ID it also takes arguments to define a 'new' and 'unlink' operator. They will be displayed as icon-only buttons then. Also added a version that can display preview thumbnails. Had to do some additional changes to make text-buttons support displaying/modifying empty RNA properties. This will be needed for workspaces, see D2451. Reviewed By: campbellbarton Differential Revision: https://developer.blender.org/D2666
2017-05-12 01:42:42 +02:00
const char *searchpropname,
const char *newop,
const char *unlinkop);
void uiTemplateSearchPreview(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bContext *C,
PointerRNA *ptr,
UI: Add template_search (version of template_ID for non-IDs) Adds a version of template_ID that can be used for non-ID properties. The property to search for and the collection to search in has to be passed to it. Like template_ID it also takes arguments to define a 'new' and 'unlink' operator. They will be displayed as icon-only buttons then. Also added a version that can display preview thumbnails. Had to do some additional changes to make text-buttons support displaying/modifying empty RNA properties. This will be needed for workspaces, see D2451. Reviewed By: campbellbarton Differential Revision: https://developer.blender.org/D2666
2017-05-12 01:42:42 +02:00
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *searchptr,
UI: Add template_search (version of template_ID for non-IDs) Adds a version of template_ID that can be used for non-ID properties. The property to search for and the collection to search in has to be passed to it. Like template_ID it also takes arguments to define a 'new' and 'unlink' operator. They will be displayed as icon-only buttons then. Also added a version that can display preview thumbnails. Had to do some additional changes to make text-buttons support displaying/modifying empty RNA properties. This will be needed for workspaces, see D2451. Reviewed By: campbellbarton Differential Revision: https://developer.blender.org/D2666
2017-05-12 01:42:42 +02:00
const char *searchpropname,
const char *newop,
const char *unlinkop,
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
int rows,
int cols);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* This is creating/editing RNA-Paths
*
* - ptr: struct which holds the path property
* - propname: property identifier for property that path gets stored to
* - root_ptr: struct that path gets built from
*/
Cleanup: right shift
2018-07-09 06:38:07 +02:00
void uiTemplatePathBuilder(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *root_ptr,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const char *text);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateModifiers(uiLayout *layout, bContext *C);
void uiTemplateGpencilModifiers(uiLayout *layout, bContext *C);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Check if the shader effect panels don't match the data and rebuild the panels if so.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateShaderFx(uiLayout *layout, bContext *C);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Check if the constraint panels don't match the data and rebuild the panels if so.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateConstraints(uiLayout *layout, bContext *C, bool use_bone_constraints);
UI: Drag and Drop Constraints, Layout Updates This patch implements the list panel system D7490 for constraints. In this case the panels are still defined in Python. The layouts are also updated to use subpanels and the a more organized single column layout. There may be more tweaks necessary for the layouts. Reviewed By: Severin, billreynish, Mets Differential Revision: https://developer.blender.org/D7499
2020-06-19 12:40:48 -04:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiLayout *uiTemplateGpencilModifier(uiLayout *layout, bContext *C, PointerRNA *ptr);
New Grease Pencil object for 2D animation This commit merge the full development done in greasepencil-object branch and include mainly the following features. - New grease pencil object. - New drawing engine. - New grease pencil modes Draw/Sculpt/Edit and Weight Paint. - New brushes for grease pencil. - New modifiers for grease pencil. - New shaders FX. - New material system (replace old palettes and colors). - Split of annotations (old grease pencil) and new grease pencil object. - UI adapted to blender 2.8. You can get more info here: https://code.blender.org/2017/12/drawing-2d-animation-in-blender-2-8/ https://code.blender.org/2018/07/grease-pencil-status-update/ This is the result of nearly two years of development and I want thanks firstly the other members of the grease pencil team: Daniel M. Lara, Matias Mendiola and Joshua Leung for their support, ideas and to keep working in the project all the time, without them this project had been impossible. Also, I want thanks other Blender developers for their help, advices and to be there always to help me, and specially to Clément Foucault, Dalai Felinto, Pablo Vázquez and Campbell Barton.
2018-07-31 10:22:19 +02:00
void uiTemplateGpencilColorPreview(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bContext *C,
PointerRNA *ptr,
Cleanup: style
2018-11-03 15:55:33 +11:00
const char *propname,
int rows,
int cols,
float scale,
int filter);
New Grease Pencil object for 2D animation This commit merge the full development done in greasepencil-object branch and include mainly the following features. - New grease pencil object. - New drawing engine. - New grease pencil modes Draw/Sculpt/Edit and Weight Paint. - New brushes for grease pencil. - New modifiers for grease pencil. - New shaders FX. - New material system (replace old palettes and colors). - Split of annotations (old grease pencil) and new grease pencil object. - UI adapted to blender 2.8. You can get more info here: https://code.blender.org/2017/12/drawing-2d-animation-in-blender-2-8/ https://code.blender.org/2018/07/grease-pencil-status-update/ This is the result of nearly two years of development and I want thanks firstly the other members of the grease pencil team: Daniel M. Lara, Matias Mendiola and Joshua Leung for their support, ideas and to keep working in the project all the time, without them this project had been impossible. Also, I want thanks other Blender developers for their help, advices and to be there always to help me, and specially to Clément Foucault, Dalai Felinto, Pablo Vázquez and Campbell Barton.
2018-07-31 10:22:19 +02:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateOperatorRedoProperties(uiLayout *layout, const bContext *C);
UI: Apply remove redo region This was a disabled part of the top-bar merge (code by @Severin) The only change made is to move to redo UI into a popover.
2018-04-25 07:52:40 +02:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateConstraintHeader(uiLayout *layout, PointerRNA *ptr);
Cleanup: right shift
2018-07-09 06:38:07 +02:00
void uiTemplatePreview(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bContext *C,
ID *id,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
bool show_buttons,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
ID *parent,
MTex *slot,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const char *preview_id);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateColorRamp(uiLayout *layout, PointerRNA *ptr, const char *propname, bool expand);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \param icon_scale: Scale of the icon, 1x == button height.
*/
T55406: Flip Matcap - Icon represent the flipped matcap in the shading menu - Added template_icon to display any icon in scale.
2018-06-14 10:38:17 +02:00
void uiTemplateIcon(uiLayout *layout, int icon_value, float icon_scale);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \param icon_scale: Scale of the icon, 1x == button height.
*/
UI: add scale option for template_icon_view button The existing scale option only changed the scale if icons in the popup.
2019-01-02 18:18:54 +11:00
void uiTemplateIconView(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
UI: add scale option for template_icon_view button The existing scale option only changed the scale if icons in the popup.
2019-01-02 18:18:54 +11:00
const char *propname,
bool show_labels,
float icon_scale,
float icon_scale_popup);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateHistogram(uiLayout *layout, PointerRNA *ptr, const char *propname);
void uiTemplateWaveform(uiLayout *layout, PointerRNA *ptr, const char *propname);
void uiTemplateVectorscope(uiLayout *layout, PointerRNA *ptr, const char *propname);
Cleanup: right shift
2018-07-09 06:38:07 +02:00
void uiTemplateCurveMapping(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const char *propname,
int type,
Compositor: Film-like curve Film-like curves for the RGB Curve node (Compositor) and Curve Modifier (Sequencer) Film-like curves originated from Adobe. "It’s an RGB curve where the tone curve is applied on the largest and smallest value, and then the middle value is adapted to keep a constant hue as defined by RGB-HSL/HSV. In terms of look and saturation increase it’s very similar to a pure RGB curve, more so than a HSL-L curve or HSV-V curve, but some color shift problems are avoided." Other tools like Natron, Krita and RawTherapee have implemented this curve tone. Reviewers: brecht, campbellbarton Reviewed By: brecht Tags: #compositing, #video_sequencer Differential Revision: https://developer.blender.org/D3638
2018-08-23 10:25:54 +02:00
bool levels,
bool brush,
bool neg_slope,
bool tone);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Template for a path creation widget intended for custom bevel profiles.
* This section is quite similar to #uiTemplateCurveMapping, but with reduced complexity.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateCurveProfile(uiLayout *layout, PointerRNA *ptr, const char *propname);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* This template now follows User Preference for type - name is not correct anymore.
*/
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
void uiTemplateColorPicker(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
const char *propname,
bool value_slider,
bool lock,
bool lock_luminosity,
bool cubic);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplatePalette(uiLayout *layout, PointerRNA *ptr, const char *propname, bool colors);
void uiTemplateCryptoPicker(uiLayout *layout, PointerRNA *ptr, const char *propname, int icon);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \todo for now, grouping of layers is determined by dividing up the length of
* the array of layer bitflags
*/
Cleanup: right shift
2018-07-09 06:38:07 +02:00
void uiTemplateLayers(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *used_ptr,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const char *used_propname,
int active_layer);
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
void uiTemplateImage(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bContext *C,
PointerRNA *ptr,
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *userptr,
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
bool compact,
bool multiview);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateImageSettings(uiLayout *layout, PointerRNA *imfptr, bool color_management);
void uiTemplateImageStereo3d(uiLayout *layout, PointerRNA *stereo3d_format_ptr);
void uiTemplateImageViews(uiLayout *layout, PointerRNA *imaptr);
void uiTemplateImageFormatViews(uiLayout *layout, PointerRNA *imfptr, PointerRNA *ptr);
void uiTemplateImageLayers(uiLayout *layout, bContext *C, Image *ima, ImageUser *iuser);
void uiTemplateImageInfo(uiLayout *layout, bContext *C, Image *ima, ImageUser *iuser);
void uiTemplateRunningJobs(uiLayout *layout, bContext *C);
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
void UI_but_func_operator_search(uiBut *but);
2.5 Image Window * Unpack operator now works. * Some small layout code tweaks. Info Window Header * Moved to python UI code. * template_running_jobs, template_operator_search added. * Ported external data operators: pack/unpack all, make paths relative/absolute, find/report missing files. Also * Report RPT_INFO too, not only warnings and errors. * Run UI handle functions after RNA and Operators. * Rename particle system add/remove operators, to not include "slot", that's only there for materials because that's what they are called now in RNA.
2009-06-30 19:20:45 +00:00
void uiTemplateOperatorSearch(uiLayout *layout);
UI: add menu search functionality to operator search menu This has some advantages over operator search: - Some operators need options set to be usefully accessed. - Shows key bindings to access menus (for actions that don't have key bindings themselves). - Non operator actions such as check-boxes are also shown. - Menu items can control execution context, using invoke or execute where appropriate so we can control how the operator runs. Part of the design task T74157. This can be tested using the 'Experimental' preferences section or selected in the key-map editor.
2020-03-24 11:34:18 +11:00
UI: support searching in menus The basic idea is very simple. Whenever a supported menu is open, one can just start typing and this opens a search that contains all the (nested) menu entries. The main downside is that this collides with accelerator keys. Those are the underlined characters in each menu. For now, we just enable this new searching behavior in a few selected menus: Node Add Menu, View3D Add Menu and Modifier Add Menu. This new functionality can be enabled for a menu by setting `bl_options = {'SEARCH_ON_KEY_PRESS'}` to true in the menu type. The status bar shows `Type to search...` when a menu is opened that supports search. Pull Request: https://projects.blender.org/blender/blender/pulls/110855
2023-09-06 18:16:45 +02:00
void UI_but_func_menu_search(uiBut *but, const char *single_menu_idname = nullptr);
UI: add menu search functionality to operator search menu This has some advantages over operator search: - Some operators need options set to be usefully accessed. - Shows key bindings to access menus (for actions that don't have key bindings themselves). - Non operator actions such as check-boxes are also shown. - Menu items can control execution context, using invoke or execute where appropriate so we can control how the operator runs. Part of the design task T74157. This can be tested using the 'Experimental' preferences section or selected in the key-map editor.
2020-03-24 11:34:18 +11:00
void uiTemplateMenuSearch(uiLayout *layout);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Draw Operator property buttons for redoing execution with different settings.
* This function does not initialize the layout,
* functions can be called on the layout before and after.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateOperatorPropertyButs(
const bContext *C, uiLayout *layout, wmOperator *op, eButLabelAlign label_align, short flag);
void uiTemplateHeader3D_mode(uiLayout *layout, bContext *C);
void uiTemplateEditModeSelection(uiLayout *layout, bContext *C);
void uiTemplateReportsBanner(uiLayout *layout, bContext *C);
void uiTemplateInputStatus(uiLayout *layout, bContext *C);
void uiTemplateStatusInfo(uiLayout *layout, bContext *C);
void uiTemplateKeymapItemProperties(uiLayout *layout, PointerRNA *ptr);
bool uiTemplateEventFromKeymapItem(uiLayout *layout,
UI: add utility to show icons for the keymap item This is useful for drawing keymap items into the header or status bar While these icons are available directly, mapping them from the keymap item isn't trivial.
2019-10-28 02:51:26 +11:00
const char *text,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const wmKeyMapItem *kmi,
UI: add utility to show icons for the keymap item This is useful for drawing keymap items into the header or status bar While these icons are available directly, mapping them from the keymap item isn't trivial.
2019-10-28 02:51:26 +11:00
bool text_fallback);
Merge of the PyNodes branch (aka "custom nodes") into trunk. PyNodes opens up the node system in Blender to scripters and adds a number of UI-level improvements. === Dynamic node type registration === Node types can now be added at runtime, using the RNA registration mechanism from python. This enables addons such as render engines to create a complete user interface with nodes. Examples of how such nodes can be defined can be found in my personal wiki docs atm [1] and as a script template in release/scripts/templates_py/custom_nodes.py [2]. === Node group improvements === Each node editor now has a tree history of edited node groups, which allows opening and editing nested node groups. The node editor also supports pinning now, so that different spaces can be used to edit different node groups simultaneously. For more ramblings and rationale see (really old) blog post on code.blender.org [3]. The interface of node groups has been overhauled. Sockets of a node group are no longer displayed in columns on either side, but instead special input/output nodes are used to mirror group sockets inside a node tree. This solves the problem of long node lines in groups and allows more adaptable node layout. Internal sockets can be exposed from a group by either connecting to the extension sockets in input/output nodes (shown as empty circle) or by adding sockets from the node property bar in the "Interface" panel. Further details such as the socket name can also be changed there. [1] http://wiki.blender.org/index.php/User:Phonybone/Python_Nodes [2] http://projects.blender.org/scm/viewvc.php/trunk/blender/release/scripts/templates_py/custom_nodes.py?view=markup&root=bf-blender [3] http://code.blender.org/index.php/2012/01/improving-node-group-interface-editing/
2013-03-18 16:34:57 +00:00
void uiTemplateComponentMenu(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
Merge of the PyNodes branch (aka "custom nodes") into trunk. PyNodes opens up the node system in Blender to scripters and adds a number of UI-level improvements. === Dynamic node type registration === Node types can now be added at runtime, using the RNA registration mechanism from python. This enables addons such as render engines to create a complete user interface with nodes. Examples of how such nodes can be defined can be found in my personal wiki docs atm [1] and as a script template in release/scripts/templates_py/custom_nodes.py [2]. === Node group improvements === Each node editor now has a tree history of edited node groups, which allows opening and editing nested node groups. The node editor also supports pinning now, so that different spaces can be used to edit different node groups simultaneously. For more ramblings and rationale see (really old) blog post on code.blender.org [3]. The interface of node groups has been overhauled. Sockets of a node group are no longer displayed in columns on either side, but instead special input/output nodes are used to mirror group sockets inside a node tree. This solves the problem of long node lines in groups and allows more adaptable node layout. Internal sockets can be exposed from a group by either connecting to the extension sockets in input/output nodes (shown as empty circle) or by adding sockets from the node property bar in the "Interface" panel. Further details such as the socket name can also be changed there. [1] http://wiki.blender.org/index.php/User:Phonybone/Python_Nodes [2] http://projects.blender.org/scm/viewvc.php/trunk/blender/release/scripts/templates_py/custom_nodes.py?view=markup&root=bf-blender [3] http://code.blender.org/index.php/2012/01/improving-node-group-interface-editing/
2013-03-18 16:34:57 +00:00
const char *propname,
const char *name);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateNodeSocket(uiLayout *layout, bContext *C, const float color[4]);
Cache File: use panels to organize UI This adds interface panels to organize the Cache File UI parameters for modifiers and constraints into related components: velocity, time, and render procedural. Properties relating to the three aforementioned components are separated from `uiTemplateCacheFile` into their own functions (e.g. `uiTemplateCacheFileVelocity` for the velocity one), which are in turn called from the specific panel creation routines of the modifiers and constraints (for constraints, the functions are exposed to the RNA). `uiTemplateCacheFile` now only shows the properties for the file path, and in the case of constraints, the scale property. The properties that are only defined per modifier (like the velocity scale), are shown in the proper modifier layout panel if applicable. Reviewed By: sybren Differential Revision: https://developer.blender.org/D13652
2021-12-23 18:05:00 +01:00
/**
* Draw the main CacheFile properties and operators (file path, scale, etc.), that is those which
* do not have their own dedicated template functions.
*/
Basic Alembic support All in all, this patch adds an Alembic importer, an Alembic exporter, and a new CacheFile data block which, for now, wraps around an Alembic archive. This data block is made available through a new modifier ("Mesh Sequence Cache") as well as a new constraint ("Transform Cache") to somewhat properly support respectively geometric and transformation data streaming from alembic caches. A more in-depth documentation is to be found on the wiki, as well as a guide to compile alembic: https://wiki.blender.org/index.php/ User:Kevindietrich/AlembicBasicIo. Many thanks to everyone involved in this little project, and huge shout out to "cgstrive" for the thorough testings with Maya, 3ds Max, Houdini and Realflow as well as @fjuhec, @jensverwiebe and @jasperge for the custom builds and compile fixes. Reviewers: sergey, campbellbarton, mont29 Reviewed By: sergey, campbellbarton, mont29 Differential Revision: https://developer.blender.org/D2060
2016-08-06 06:20:37 +02:00
void uiTemplateCacheFile(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const bContext *C,
PointerRNA *ptr,
Basic Alembic support All in all, this patch adds an Alembic importer, an Alembic exporter, and a new CacheFile data block which, for now, wraps around an Alembic archive. This data block is made available through a new modifier ("Mesh Sequence Cache") as well as a new constraint ("Transform Cache") to somewhat properly support respectively geometric and transformation data streaming from alembic caches. A more in-depth documentation is to be found on the wiki, as well as a guide to compile alembic: https://wiki.blender.org/index.php/ User:Kevindietrich/AlembicBasicIo. Many thanks to everyone involved in this little project, and huge shout out to "cgstrive" for the thorough testings with Maya, 3ds Max, Houdini and Realflow as well as @fjuhec, @jensverwiebe and @jasperge for the custom builds and compile fixes. Reviewers: sergey, campbellbarton, mont29 Reviewed By: sergey, campbellbarton, mont29 Differential Revision: https://developer.blender.org/D2060
2016-08-06 06:20:37 +02:00
const char *propname);
2.5: UI Layout Engine, initial code. * As a test, used by: * Object buttons, tried to make it match the mockup. * Text window header. * Text window properties panel. * Panel interaction with view2d is still problematic, need to make this work properly still. * Templates are very basic, the ones there are simple but already can follow the object buttons mockup quite closely. * It's based on a three level system: panels, templates and items. To get an idea of what that means in practice, see: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/UI_LayoutEngine#Panels.2C_Templates_and_Items
2009-03-13 13:38:41 +00:00
Cache File: use panels to organize UI This adds interface panels to organize the Cache File UI parameters for modifiers and constraints into related components: velocity, time, and render procedural. Properties relating to the three aforementioned components are separated from `uiTemplateCacheFile` into their own functions (e.g. `uiTemplateCacheFileVelocity` for the velocity one), which are in turn called from the specific panel creation routines of the modifiers and constraints (for constraints, the functions are exposed to the RNA). `uiTemplateCacheFile` now only shows the properties for the file path, and in the case of constraints, the scale property. The properties that are only defined per modifier (like the velocity scale), are shown in the proper modifier layout panel if applicable. Reviewed By: sybren Differential Revision: https://developer.blender.org/D13652
2021-12-23 18:05:00 +01:00
/**
* Lookup the CacheFile PointerRNA of the given pointer and return it in the output parameter.
* Returns true if `ptr` has a RNACacheFile, false otherwise. If false, the output parameter is not
* initialized.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool uiTemplateCacheFilePointer(PointerRNA *ptr, const char *propname, PointerRNA *r_file_ptr);
Cache File: use panels to organize UI This adds interface panels to organize the Cache File UI parameters for modifiers and constraints into related components: velocity, time, and render procedural. Properties relating to the three aforementioned components are separated from `uiTemplateCacheFile` into their own functions (e.g. `uiTemplateCacheFileVelocity` for the velocity one), which are in turn called from the specific panel creation routines of the modifiers and constraints (for constraints, the functions are exposed to the RNA). `uiTemplateCacheFile` now only shows the properties for the file path, and in the case of constraints, the scale property. The properties that are only defined per modifier (like the velocity scale), are shown in the proper modifier layout panel if applicable. Reviewed By: sybren Differential Revision: https://developer.blender.org/D13652
2021-12-23 18:05:00 +01:00
/**
* Draw the velocity related properties of the CacheFile.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateCacheFileVelocity(uiLayout *layout, PointerRNA *fileptr);
Cache File: use panels to organize UI This adds interface panels to organize the Cache File UI parameters for modifiers and constraints into related components: velocity, time, and render procedural. Properties relating to the three aforementioned components are separated from `uiTemplateCacheFile` into their own functions (e.g. `uiTemplateCacheFileVelocity` for the velocity one), which are in turn called from the specific panel creation routines of the modifiers and constraints (for constraints, the functions are exposed to the RNA). `uiTemplateCacheFile` now only shows the properties for the file path, and in the case of constraints, the scale property. The properties that are only defined per modifier (like the velocity scale), are shown in the proper modifier layout panel if applicable. Reviewed By: sybren Differential Revision: https://developer.blender.org/D13652
2021-12-23 18:05:00 +01:00
/**
* Draw the render procedural related properties of the CacheFile.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateCacheFileProcedural(uiLayout *layout, const bContext *C, PointerRNA *fileptr);
Cache File: use panels to organize UI This adds interface panels to organize the Cache File UI parameters for modifiers and constraints into related components: velocity, time, and render procedural. Properties relating to the three aforementioned components are separated from `uiTemplateCacheFile` into their own functions (e.g. `uiTemplateCacheFileVelocity` for the velocity one), which are in turn called from the specific panel creation routines of the modifiers and constraints (for constraints, the functions are exposed to the RNA). `uiTemplateCacheFile` now only shows the properties for the file path, and in the case of constraints, the scale property. The properties that are only defined per modifier (like the velocity scale), are shown in the proper modifier layout panel if applicable. Reviewed By: sybren Differential Revision: https://developer.blender.org/D13652
2021-12-23 18:05:00 +01:00
/**
* Draw the time related properties of the CacheFile.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateCacheFileTimeSettings(uiLayout *layout, PointerRNA *fileptr);
Cache File: use panels to organize UI This adds interface panels to organize the Cache File UI parameters for modifiers and constraints into related components: velocity, time, and render procedural. Properties relating to the three aforementioned components are separated from `uiTemplateCacheFile` into their own functions (e.g. `uiTemplateCacheFileVelocity` for the velocity one), which are in turn called from the specific panel creation routines of the modifiers and constraints (for constraints, the functions are exposed to the RNA). `uiTemplateCacheFile` now only shows the properties for the file path, and in the case of constraints, the scale property. The properties that are only defined per modifier (like the velocity scale), are shown in the proper modifier layout panel if applicable. Reviewed By: sybren Differential Revision: https://developer.blender.org/D13652
2021-12-23 18:05:00 +01:00
Alembic: add support for reading override layers Override layers are a standard feature of Alembic, where archives can override data from other archives, provided that the hierarchies match. This is useful for modifying a UV map, updating an animation, or even creating some sort of LOD system where low resolution meshes are swapped by high resolution versions. It is possible to add UV maps and vertex colors using this system, however, they will only appear in the spreadsheet editor when viewing evaluated data, as the UV map and Vertex color UI only show data present on the original mesh. Implementation wise, this adds a `CacheFileLayer` data structure to the `CacheFile` DNA, as well as some operators and UI to present and manage the layers. For both the Alembic importer and the Cycles procedural, the main change is creating an archive from a list of filepaths, instead of a single one. After importing the base file through the regular import operator, layers can be added to or removed from the `CacheFile` via the UI list under the `Override Layers` panel located in the Mesh Sequence Cache modifier. Layers can also be moved around or hidden. See differential page for tests files and demos. Reviewed by: brecht, sybren Differential Revision: https://developer.blender.org/D13603
2022-01-17 14:50:47 +01:00
/**
* Draw the override layers related properties of the CacheFile.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateCacheFileLayers(uiLayout *layout, const bContext *C, PointerRNA *fileptr);
Alembic: add support for reading override layers Override layers are a standard feature of Alembic, where archives can override data from other archives, provided that the hierarchies match. This is useful for modifying a UV map, updating an animation, or even creating some sort of LOD system where low resolution meshes are swapped by high resolution versions. It is possible to add UV maps and vertex colors using this system, however, they will only appear in the spreadsheet editor when viewing evaluated data, as the UV map and Vertex color UI only show data present on the original mesh. Implementation wise, this adds a `CacheFileLayer` data structure to the `CacheFile` DNA, as well as some operators and UI to present and manage the layers. For both the Alembic importer and the Cycles procedural, the main change is creating an archive from a list of filepaths, instead of a single one. After importing the base file through the regular import operator, layers can be added to or removed from the `CacheFile` via the UI list under the `Override Layers` panel located in the Mesh Sequence Cache modifier. Layers can also be moved around or hidden. See differential page for tests files and demos. Reviewed by: brecht, sybren Differential Revision: https://developer.blender.org/D13603
2022-01-17 14:50:47 +01:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Default UIList class name, keep in sync with its declaration in `bl_ui/__init__.py`. */
Make list_id mandatory when using default UI_UL_list class for a template_list.
2013-02-18 14:03:26 +00:00
#define UI_UL_DEFAULT_CLASS_NAME "UI_UL_list"
UI: UI list refactor & preparations for asset view template This is more of a first-pass refactor for the UI list template. More improvements could be done, but that's better done separately. Main purpose of this is to make the UI list code more manageable and ready for the asset view template. No functional changes for users. * Split the huge template function into more manageable functions, with clear names and a few structs with high coherency. * Move runtime data management to the template code, with a free callback called from BKE. This is UI data and should be managed at that level. * Replace boolean arguments with bit-flags (easily extendable and more readable from the caller). * Allow passing custom-data to the UI list for callbacks to access. * Make list grip button for resizing optional. * Put logic for generating the internal UI list identifier (stored in .blends) into function. This is a quite important bit and a later commit adds a related function. Good to have a clear API for this. * Improve naming, comments, etc. As part of further cleanups I'd like to move this to an own file.
2021-07-14 16:01:53 +02:00
enum uiTemplateListFlags {
UI_TEMPLATE_LIST_FLAG_NONE = 0,
UI_TEMPLATE_LIST_SORT_REVERSE = (1 << 0),
UI_TEMPLATE_LIST_SORT_LOCK = (1 << 1),
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Don't allow resizing the list, i.e. don't add the grip button. */
UI: UI list refactor & preparations for asset view template This is more of a first-pass refactor for the UI list template. More improvements could be done, but that's better done separately. Main purpose of this is to make the UI list code more manageable and ready for the asset view template. No functional changes for users. * Split the huge template function into more manageable functions, with clear names and a few structs with high coherency. * Move runtime data management to the template code, with a free callback called from BKE. This is UI data and should be managed at that level. * Replace boolean arguments with bit-flags (easily extendable and more readable from the caller). * Allow passing custom-data to the UI list for callbacks to access. * Make list grip button for resizing optional. * Put logic for generating the internal UI list identifier (stored in .blends) into function. This is a quite important bit and a later commit adds a related function. Good to have a clear API for this. * Improve naming, comments, etc. As part of further cleanups I'd like to move this to an own file.
2021-07-14 16:01:53 +02:00
UI_TEMPLATE_LIST_NO_GRIP = (1 << 2),
Asset Template: Extra UI options This allow users to show/hide: * Library name / refresh. * Assets names. * Filter. To set them in Python use: display_options={'NO_NAMES', 'NO_FILTER', 'NO_LIBRARY'} With contributions by Julian Eisel. Differential Revision: https://developer.blender.org/D12476
2021-09-13 18:40:21 +02:00
/** Do not show filtering options, not even the button to expand/collapse them. Also hides the
* grip button. */
UI_TEMPLATE_LIST_NO_FILTER_OPTIONS = (1 << 3),
/** For #UILST_LAYOUT_BIG_PREVIEW_GRID, don't reserve space for the name label. */
UI_TEMPLATE_LIST_NO_NAMES = (1 << 4),
UI: UI list refactor & preparations for asset view template This is more of a first-pass refactor for the UI list template. More improvements could be done, but that's better done separately. Main purpose of this is to make the UI list code more manageable and ready for the asset view template. No functional changes for users. * Split the huge template function into more manageable functions, with clear names and a few structs with high coherency. * Move runtime data management to the template code, with a free callback called from BKE. This is UI data and should be managed at that level. * Replace boolean arguments with bit-flags (easily extendable and more readable from the caller). * Allow passing custom-data to the UI list for callbacks to access. * Make list grip button for resizing optional. * Put logic for generating the internal UI list identifier (stored in .blends) into function. This is a quite important bit and a later commit adds a related function. Good to have a clear API for this. * Improve naming, comments, etc. As part of further cleanups I'd like to move this to an own file.
2021-07-14 16:01:53 +02:00
UI_TEMPLATE_LIST_FLAGS_LAST
};
Cleanup: Move UI RNA files to C++ See #103343 Pull Request: https://projects.blender.org/blender/blender/pulls/109090
2023-06-18 01:39:21 +02:00
ENUM_OPERATORS(uiTemplateListFlags, UI_TEMPLATE_LIST_FLAGS_LAST);
UI: UI list refactor & preparations for asset view template This is more of a first-pass refactor for the UI list template. More improvements could be done, but that's better done separately. Main purpose of this is to make the UI list code more manageable and ready for the asset view template. No functional changes for users. * Split the huge template function into more manageable functions, with clear names and a few structs with high coherency. * Move runtime data management to the template code, with a free callback called from BKE. This is UI data and should be managed at that level. * Replace boolean arguments with bit-flags (easily extendable and more readable from the caller). * Allow passing custom-data to the UI list for callbacks to access. * Make list grip button for resizing optional. * Put logic for generating the internal UI list identifier (stored in .blends) into function. This is a quite important bit and a later commit adds a related function. Good to have a clear API for this. * Improve naming, comments, etc. As part of further cleanups I'd like to move this to an own file.
2021-07-14 16:01:53 +02:00
Cleanup: right shift
2018-07-09 06:38:07 +02:00
void uiTemplateList(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const bContext *C,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const char *listtype_name,
const char *list_id,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *dataptr,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *active_dataptr,
Cleanup: right shift
2018-07-09 06:38:07 +02:00
const char *active_propname,
const char *item_dyntip_propname,
Revert/Redo ugly rBd12b3767f81d commit (i.e. add locked sorting option to UIList). Too many things done wrong in original rBd12b3767f81d to list them all here, hopefully nothing bad sneaked in again this time :| Also cleaned up a little the 'sort by name', even though (since we only have two options by default, sort by index and by name) we can abuse it as a binary option for now, this is not a bitflag...
2019-01-09 15:48:09 +01:00
int rows,
int maxrows,
int layout_type,
int columns,
UI: UI list refactor & preparations for asset view template This is more of a first-pass refactor for the UI list template. More improvements could be done, but that's better done separately. Main purpose of this is to make the UI list code more manageable and ready for the asset view template. No functional changes for users. * Split the huge template function into more manageable functions, with clear names and a few structs with high coherency. * Move runtime data management to the template code, with a free callback called from BKE. This is UI data and should be managed at that level. * Replace boolean arguments with bit-flags (easily extendable and more readable from the caller). * Allow passing custom-data to the UI list for callbacks to access. * Make list grip button for resizing optional. * Put logic for generating the internal UI list identifier (stored in .blends) into function. This is a quite important bit and a later commit adds a related function. Good to have a clear API for this. * Improve naming, comments, etc. As part of further cleanups I'd like to move this to an own file.
2021-07-14 16:01:53 +02:00
enum uiTemplateListFlags flags);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiList *uiTemplateList_ex(uiLayout *layout,
const bContext *C,
const char *listtype_name,
const char *list_id,
PointerRNA *dataptr,
const char *propname,
PointerRNA *active_dataptr,
const char *active_propname,
const char *item_dyntip_propname,
int rows,
int maxrows,
int layout_type,
int columns,
enum uiTemplateListFlags flags,
void *customdata);
void uiTemplateNodeLink(
uiLayout *layout, bContext *C, bNodeTree *ntree, bNode *node, bNodeSocket *input);
void uiTemplateNodeView(
uiLayout *layout, bContext *C, bNodeTree *ntree, bNode *node, bNodeSocket *input);
void uiTemplateTextureUser(uiLayout *layout, bContext *C);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Button to quickly show texture in Properties Editor texture tab.
*/
Texturing: texture and 3d view draw type changes, these should only have any effect for a render engine using new shading nodes. In short: * No longer uses images assigned to faces in the uv layer, rather the active image texture node is what is edited/painted/drawn. * Textured draw type now shows the active image texture node, with solid lighting. * Material draw mode shows GLSL shader of a simplified material node tree, using solid lighting. * Textures for modifiers, brushes, etc, are now available from a dropdown in the texture tab in the properties editor. These do not use new shading nodes yet. http://wiki.blender.org/index.php/Dev:2.6/Source/Render/TextureWorkflow
2011-11-08 13:07:16 +00:00
void uiTemplateTextureShow(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const bContext *C,
PointerRNA *ptr,
PropertyRNA *prop);
void uiTemplateMovieClip(
uiLayout *layout, bContext *C, PointerRNA *ptr, const char *propname, bool compact);
void uiTemplateTrack(uiLayout *layout, PointerRNA *ptr, const char *propname);
void uiTemplateMarker(uiLayout *layout,
PointerRNA *ptr,
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *userptr,
PointerRNA *trackptr,
RNA: use bool for boolean RNA types We were using int's for bool arguments in BKE, just to avoid having wrapper functions.
2018-07-01 15:47:09 +02:00
bool compact);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateMovieclipInformation(uiLayout *layout,
PointerRNA *ptr,
style cleanup
2013-04-23 05:29:06 +00:00
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *userptr);
void uiTemplateColorspaceSettings(uiLayout *layout, PointerRNA *ptr, const char *propname);
void uiTemplateColormanagedViewSettings(uiLayout *layout,
bContext *C,
PointerRNA *ptr,
Color Management, Stage 2: Switch color pipeline to use OpenColorIO Replace old color pipeline which was supporting linear/sRGB color spaces only with OpenColorIO-based pipeline. This introduces two configurable color spaces: - Input color space for images and movie clips. This space is used to convert images/movies from color space in which file is saved to Blender's linear space (for float images, byte images are not internally converted, only input space is stored for such images and used later). This setting could be found in image/clip data block settings. - Display color space which defines space in which particular display is working. This settings could be found in scene's Color Management panel. When render result is being displayed on the screen, apart from converting image to display space, some additional conversions could happen. This conversions are: - View, which defines tone curve applying before display transformation. These are different ways to view the image on the same display device. For example it could be used to emulate film view on sRGB display. - Exposure affects on image exposure before tone map is applied. - Gamma is post-display gamma correction, could be used to match particular display gamma. - RGB curves are user-defined curves which are applying before display transformation, could be used for different purposes. All this settings by default are only applying on render result and does not affect on other images. If some particular image needs to be affected by this transformation, "View as Render" setting of image data block should be set to truth. Movie clips are always affected by all display transformations. This commit also introduces configurable color space in which sequencer is working. This setting could be found in scene's Color Management panel and it should be used if such stuff as grading needs to be done in color space different from sRGB (i.e. when Film view on sRGB display is use, using VD16 space as sequencer's internal space would make grading working in space which is close to the space using for display). Some technical notes: - Image buffer's float buffer is now always in linear space, even if it was created from 16bit byte images. - Space of byte buffer is stored in image buffer's rect_colorspace property. - Profile of image buffer was removed since it's not longer meaningful. - OpenGL and GLSL is supposed to always work in sRGB space. It is possible to support other spaces, but it's quite large project which isn't so much important. - Legacy Color Management option disabled is emulated by using None display. It could have some regressions, but there's no clear way to avoid them. - If OpenColorIO is disabled on build time, it should make blender behaving in the same way as previous release with color management enabled. More details could be found at this page (more details would be added soon): http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.64/Color_Management -- Thanks to Xavier Thomas, Lukas Toene for initial work on OpenColorIO integration and to Brecht van Lommel for some further development and code/ usecase review!
2012-09-15 10:05:07 +00:00
const char *propname);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int uiTemplateRecentFiles(uiLayout *layout, int rows);
void uiTemplateFileSelectPath(uiLayout *layout, bContext *C, FileSelectParams *params);
Asset Template: Extra UI options This allow users to show/hide: * Library name / refresh. * Assets names. * Filter. To set them in Python use: display_options={'NO_NAMES', 'NO_FILTER', 'NO_LIBRARY'} With contributions by Julian Eisel. Differential Revision: https://developer.blender.org/D12476
2021-09-13 18:40:21 +02:00
enum {
UI_TEMPLATE_ASSET_DRAW_NO_NAMES = (1 << 0),
UI_TEMPLATE_ASSET_DRAW_NO_FILTER = (1 << 1),
UI_TEMPLATE_ASSET_DRAW_NO_LIBRARY = (1 << 2),
};
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateAssetView(uiLayout *layout,
const bContext *C,
UI/Assets: Initial Asset View UI template The asset view UI template is a mini-version of the Asset Browser that can be placed in regular layouts, regions or popups. At this point it's made specifically for placement in vertical layouts, it can be made more flexible in the future. Generally the way this is implemented will likely change a lot still as the asset system evolves. The Pose Library add-on will use the asset view to display pose libraries in the 3D View sidebar. References: * https://developer.blender.org/T86139 * https://code.blender.org/2021/06/asset-browser-project-update/#what-are-we-building * https://code.blender.org/2021/05/pose-library-v2-0/#use-from-3d-viewport Notes: * Important limitation: Due to the early & WIP implementation of the asset list, all asset views showing the same library will show the same assets. That is despite the ID type filter option the template provides. The first asset view created will determine what's visible. Of course this should be made to work eventually. * The template supports passing an activate and a drag operator name. The former is called when an asset is clicked on (e.g. to apply the asset) the latter when dragging (e.g. to .blend a pose asset). If no drag operator is set, regular asset drag & drop will be executed. * The template returns the properties for both operators (see example below). * The argument list for using the template is quite long, but we can't avoid that currently. The UI list design requires that we pass a number of RNA or custom properties to work with, that for the Pose Libraries should be registered at the Pose Library add-on level, not in core Blender. * Idea is that Python scripts or add-ons that want to use the asset view can register custom properties, to hold data like the list of assets, and the active asset index. Maybe that will change in future and we can manage these internally. As an example, the pose library add-on uses it like this: ``` activate_op_props, drag_op_props = layout.template_asset_view( "pose_assets", workspace, "active_asset_library", wm, "pose_assets", workspace, "active_pose_asset_index", filter_id_types={"filter_action"}, activate_operator="poselib.apply_pose_asset", drag_operator="poselib.blend_pose_asset", ) drag_op_props.release_confirm = True drag_op_props.flipped = wm.poselib_flipped activate_op_props.flipped = wm.poselib_flipped ```
2021-07-13 18:07:57 +02:00
const char *list_id,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *asset_library_dataptr,
UI/Assets: Initial Asset View UI template The asset view UI template is a mini-version of the Asset Browser that can be placed in regular layouts, regions or popups. At this point it's made specifically for placement in vertical layouts, it can be made more flexible in the future. Generally the way this is implemented will likely change a lot still as the asset system evolves. The Pose Library add-on will use the asset view to display pose libraries in the 3D View sidebar. References: * https://developer.blender.org/T86139 * https://code.blender.org/2021/06/asset-browser-project-update/#what-are-we-building * https://code.blender.org/2021/05/pose-library-v2-0/#use-from-3d-viewport Notes: * Important limitation: Due to the early & WIP implementation of the asset list, all asset views showing the same library will show the same assets. That is despite the ID type filter option the template provides. The first asset view created will determine what's visible. Of course this should be made to work eventually. * The template supports passing an activate and a drag operator name. The former is called when an asset is clicked on (e.g. to apply the asset) the latter when dragging (e.g. to .blend a pose asset). If no drag operator is set, regular asset drag & drop will be executed. * The template returns the properties for both operators (see example below). * The argument list for using the template is quite long, but we can't avoid that currently. The UI list design requires that we pass a number of RNA or custom properties to work with, that for the Pose Libraries should be registered at the Pose Library add-on level, not in core Blender. * Idea is that Python scripts or add-ons that want to use the asset view can register custom properties, to hold data like the list of assets, and the active asset index. Maybe that will change in future and we can manage these internally. As an example, the pose library add-on uses it like this: ``` activate_op_props, drag_op_props = layout.template_asset_view( "pose_assets", workspace, "active_asset_library", wm, "pose_assets", workspace, "active_pose_asset_index", filter_id_types={"filter_action"}, activate_operator="poselib.apply_pose_asset", drag_operator="poselib.blend_pose_asset", ) drag_op_props.release_confirm = True drag_op_props.flipped = wm.poselib_flipped activate_op_props.flipped = wm.poselib_flipped ```
2021-07-13 18:07:57 +02:00
const char *asset_library_propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *assets_dataptr,
UI/Assets: Initial Asset View UI template The asset view UI template is a mini-version of the Asset Browser that can be placed in regular layouts, regions or popups. At this point it's made specifically for placement in vertical layouts, it can be made more flexible in the future. Generally the way this is implemented will likely change a lot still as the asset system evolves. The Pose Library add-on will use the asset view to display pose libraries in the 3D View sidebar. References: * https://developer.blender.org/T86139 * https://code.blender.org/2021/06/asset-browser-project-update/#what-are-we-building * https://code.blender.org/2021/05/pose-library-v2-0/#use-from-3d-viewport Notes: * Important limitation: Due to the early & WIP implementation of the asset list, all asset views showing the same library will show the same assets. That is despite the ID type filter option the template provides. The first asset view created will determine what's visible. Of course this should be made to work eventually. * The template supports passing an activate and a drag operator name. The former is called when an asset is clicked on (e.g. to apply the asset) the latter when dragging (e.g. to .blend a pose asset). If no drag operator is set, regular asset drag & drop will be executed. * The template returns the properties for both operators (see example below). * The argument list for using the template is quite long, but we can't avoid that currently. The UI list design requires that we pass a number of RNA or custom properties to work with, that for the Pose Libraries should be registered at the Pose Library add-on level, not in core Blender. * Idea is that Python scripts or add-ons that want to use the asset view can register custom properties, to hold data like the list of assets, and the active asset index. Maybe that will change in future and we can manage these internally. As an example, the pose library add-on uses it like this: ``` activate_op_props, drag_op_props = layout.template_asset_view( "pose_assets", workspace, "active_asset_library", wm, "pose_assets", workspace, "active_pose_asset_index", filter_id_types={"filter_action"}, activate_operator="poselib.apply_pose_asset", drag_operator="poselib.blend_pose_asset", ) drag_op_props.release_confirm = True drag_op_props.flipped = wm.poselib_flipped activate_op_props.flipped = wm.poselib_flipped ```
2021-07-13 18:07:57 +02:00
const char *assets_propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *active_dataptr,
UI/Assets: Initial Asset View UI template The asset view UI template is a mini-version of the Asset Browser that can be placed in regular layouts, regions or popups. At this point it's made specifically for placement in vertical layouts, it can be made more flexible in the future. Generally the way this is implemented will likely change a lot still as the asset system evolves. The Pose Library add-on will use the asset view to display pose libraries in the 3D View sidebar. References: * https://developer.blender.org/T86139 * https://code.blender.org/2021/06/asset-browser-project-update/#what-are-we-building * https://code.blender.org/2021/05/pose-library-v2-0/#use-from-3d-viewport Notes: * Important limitation: Due to the early & WIP implementation of the asset list, all asset views showing the same library will show the same assets. That is despite the ID type filter option the template provides. The first asset view created will determine what's visible. Of course this should be made to work eventually. * The template supports passing an activate and a drag operator name. The former is called when an asset is clicked on (e.g. to apply the asset) the latter when dragging (e.g. to .blend a pose asset). If no drag operator is set, regular asset drag & drop will be executed. * The template returns the properties for both operators (see example below). * The argument list for using the template is quite long, but we can't avoid that currently. The UI list design requires that we pass a number of RNA or custom properties to work with, that for the Pose Libraries should be registered at the Pose Library add-on level, not in core Blender. * Idea is that Python scripts or add-ons that want to use the asset view can register custom properties, to hold data like the list of assets, and the active asset index. Maybe that will change in future and we can manage these internally. As an example, the pose library add-on uses it like this: ``` activate_op_props, drag_op_props = layout.template_asset_view( "pose_assets", workspace, "active_asset_library", wm, "pose_assets", workspace, "active_pose_asset_index", filter_id_types={"filter_action"}, activate_operator="poselib.apply_pose_asset", drag_operator="poselib.blend_pose_asset", ) drag_op_props.release_confirm = True drag_op_props.flipped = wm.poselib_flipped activate_op_props.flipped = wm.poselib_flipped ```
2021-07-13 18:07:57 +02:00
const char *active_propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const AssetFilterSettings *filter_settings,
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
int display_flags,
UI/Assets: Initial Asset View UI template The asset view UI template is a mini-version of the Asset Browser that can be placed in regular layouts, regions or popups. At this point it's made specifically for placement in vertical layouts, it can be made more flexible in the future. Generally the way this is implemented will likely change a lot still as the asset system evolves. The Pose Library add-on will use the asset view to display pose libraries in the 3D View sidebar. References: * https://developer.blender.org/T86139 * https://code.blender.org/2021/06/asset-browser-project-update/#what-are-we-building * https://code.blender.org/2021/05/pose-library-v2-0/#use-from-3d-viewport Notes: * Important limitation: Due to the early & WIP implementation of the asset list, all asset views showing the same library will show the same assets. That is despite the ID type filter option the template provides. The first asset view created will determine what's visible. Of course this should be made to work eventually. * The template supports passing an activate and a drag operator name. The former is called when an asset is clicked on (e.g. to apply the asset) the latter when dragging (e.g. to .blend a pose asset). If no drag operator is set, regular asset drag & drop will be executed. * The template returns the properties for both operators (see example below). * The argument list for using the template is quite long, but we can't avoid that currently. The UI list design requires that we pass a number of RNA or custom properties to work with, that for the Pose Libraries should be registered at the Pose Library add-on level, not in core Blender. * Idea is that Python scripts or add-ons that want to use the asset view can register custom properties, to hold data like the list of assets, and the active asset index. Maybe that will change in future and we can manage these internally. As an example, the pose library add-on uses it like this: ``` activate_op_props, drag_op_props = layout.template_asset_view( "pose_assets", workspace, "active_asset_library", wm, "pose_assets", workspace, "active_pose_asset_index", filter_id_types={"filter_action"}, activate_operator="poselib.apply_pose_asset", drag_operator="poselib.blend_pose_asset", ) drag_op_props.release_confirm = True drag_op_props.flipped = wm.poselib_flipped activate_op_props.flipped = wm.poselib_flipped ```
2021-07-13 18:07:57 +02:00
const char *activate_opname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *r_activate_op_properties,
UI/Assets: Initial Asset View UI template The asset view UI template is a mini-version of the Asset Browser that can be placed in regular layouts, regions or popups. At this point it's made specifically for placement in vertical layouts, it can be made more flexible in the future. Generally the way this is implemented will likely change a lot still as the asset system evolves. The Pose Library add-on will use the asset view to display pose libraries in the 3D View sidebar. References: * https://developer.blender.org/T86139 * https://code.blender.org/2021/06/asset-browser-project-update/#what-are-we-building * https://code.blender.org/2021/05/pose-library-v2-0/#use-from-3d-viewport Notes: * Important limitation: Due to the early & WIP implementation of the asset list, all asset views showing the same library will show the same assets. That is despite the ID type filter option the template provides. The first asset view created will determine what's visible. Of course this should be made to work eventually. * The template supports passing an activate and a drag operator name. The former is called when an asset is clicked on (e.g. to apply the asset) the latter when dragging (e.g. to .blend a pose asset). If no drag operator is set, regular asset drag & drop will be executed. * The template returns the properties for both operators (see example below). * The argument list for using the template is quite long, but we can't avoid that currently. The UI list design requires that we pass a number of RNA or custom properties to work with, that for the Pose Libraries should be registered at the Pose Library add-on level, not in core Blender. * Idea is that Python scripts or add-ons that want to use the asset view can register custom properties, to hold data like the list of assets, and the active asset index. Maybe that will change in future and we can manage these internally. As an example, the pose library add-on uses it like this: ``` activate_op_props, drag_op_props = layout.template_asset_view( "pose_assets", workspace, "active_asset_library", wm, "pose_assets", workspace, "active_pose_asset_index", filter_id_types={"filter_action"}, activate_operator="poselib.apply_pose_asset", drag_operator="poselib.blend_pose_asset", ) drag_op_props.release_confirm = True drag_op_props.flipped = wm.poselib_flipped activate_op_props.flipped = wm.poselib_flipped ```
2021-07-13 18:07:57 +02:00
const char *drag_opname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *r_drag_op_properties);
Splash: add first time setup and templates to splash screen. The first time setup screen only has the interaction preset currently, some more work is needed to be able to set e.g. the language or compute device here as in the mockups. The splash screen stayed the same for now, to make room for the templates most of the links are now in the Help menu. If there are no recent files yet the links still show. The splash screen buttons implementation was fully moved to Python, in the WM_MT_splash menu.
2018-09-18 17:44:14 +02:00
Light linking: Make list interface look more similar to other places This change makes it so the list interface in the properties panels looks closer to things like shape keys, vertex groups and so on: there are two buttons to add selected objects to the collection and remove active item from the collection, as well as the "extra" drop down menu. The add operator adds selected objects to the light linking collection using the Include policy. For the light linking it means that the objects are added as receivers that receive the light, and for the shadow linking it means that objects are added as blockers which cast shadow from the light. The communication of the active list element is done via context property similar to how it was done before. The difference is that these properties are set on a parent of the list layout, which makes it so they are inherited by the layout hierarchy needed to place the Remove button. Pull Request: https://projects.blender.org/blender/blender/pulls/112713
2023-09-22 17:44:25 +02:00
void uiTemplateLightLinkingCollection(uiLayout *layout,
uiLayout *context_layout,
PointerRNA *ptr,
const char *propname);
Cycles: light and shadow linking With light linking, lights can be set to affect only specific objects in the scene. Shadow linking additionally gives control over which objects acts a shadow blockers for a light. Usage: https://wiki.blender.org/wiki/Reference/Release_Notes/4.0/Cycles Implementation: https://wiki.blender.org/wiki/Source/Render/Cycles/LightLinking Ref #104972 Co-authored-by: Brecht Van Lommel <brecht@blender.org>
2023-05-24 13:36:13 +02:00
Fix: Expose GPv3 RNA only in experimental The `blender-v4.0-release` branch would not build because some parts of grease pencil v3 were still exposed when experimental features are disabled. This is hiding the relevant parts behind `#ifdef WITH_GREASE_PENCIL_V3` to make sure they are only built when the experimental features is enabled. Pull Request: https://projects.blender.org/blender/blender/pulls/112953
2023-09-27 15:46:18 +02:00
#ifdef WITH_GREASE_PENCIL_V3
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiTemplateGreasePencilLayerTree(uiLayout *layout, bContext *C);
Fix: Expose GPv3 RNA only in experimental The `blender-v4.0-release` branch would not build because some parts of grease pencil v3 were still exposed when experimental features are disabled. This is hiding the relevant parts behind `#ifdef WITH_GREASE_PENCIL_V3` to make sure they are only built when the experimental features is enabled. Pull Request: https://projects.blender.org/blender/blender/pulls/112953
2023-09-27 15:46:18 +02:00
#endif
GPv3: Initial Layer Tree UI Adds a new UI template to view the current layer tree of the active Grease Pencil object. This UI tree view implements the following features (for now): - Displaying all the layers with their names and highlighting the active layer. - Changing the active layer by clicking on an item. - Adding new layers (using a new operator). - Removing the active layer (using a new operator). - Renaming a layer. Pull Request: https://projects.blender.org/blender/blender/pulls/109197
2023-06-22 10:51:43 +02:00
Nodes: Panels integration with blend files and UI Part 3/3 of #109135, #110272 Switch to new node group interfaces and deprecate old DNA and API. This completes support for panels in node drawing and in node group interface declarations in particular. The new node group interface DNA and RNA code has been added in parts 1 and 2 (#110885, #110952) but has not be enabled yet. This commit completes the integration by * enabling the new RNA API * using the new API in UI * read/write new interfaces from blend files * add versioning for backward compatibility * add forward-compatible writing code to reconstruct old interfaces All places accessing node group interface declarations should now be using the new API. A runtime cache has been added that allows simple linear access to socket inputs and outputs even when a panel hierarchy is used. Old DNA has been deprecated and should only be accessed for versioning (inputs/outputs renamed to inputs_legacy/outputs_legacy to catch errors). Versioning code ensures both backward and forward compatibility of existing files. The API for old interfaces is removed. The new API is very similar but is defined on the `ntree.interface` instead of the `ntree` directly. Breaking change notifications and detailed instructions for migrating will be added. A python test has been added for the node group API functions. This includes new functionality such as creating panels and moving items between different levels. This patch does not yet contain panel representations in the modifier UI. This has been tested in a separate branch and will be added with a later PR (#108565). Pull Request: https://projects.blender.org/blender/blender/pulls/111348
2023-08-30 12:37:21 +02:00
void uiTemplateNodeTreeInterface(struct uiLayout *layout, struct PointerRNA *ptr);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \return: A RNA pointer for the operator properties.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *UI_list_custom_activate_operator_set(uiList *ui_list,
const char *opname,
bool create_properties);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \return: A RNA pointer for the operator properties.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *UI_list_custom_drag_operator_set(uiList *ui_list,
const char *opname,
bool create_properties);
UI: Internal support for custom UI list item drag & activate operators For pose libraries, we need to be able to apply a pose whenever activating (clicking) an item in the Pose Library asset view and blend it by dragging (press & move). And since we want to allow Python scripts to define what happens at least when activating an asset (so they can define for example a custom "Apply" operator for preset assets), it makes sense to just let them pass an operator name to the asset view template. The template will be introduced in a following commit.
2021-07-09 21:46:55 +02:00
2.5: UI Layout Engine, initial code. * As a test, used by: * Object buttons, tried to make it match the mockup. * Text window header. * Text window properties panel. * Panel interaction with view2d is still problematic, need to make this work properly still. * Templates are very basic, the ones there are simple but already can follow the object buttons mockup quite closely. * It's based on a three level system: panels, templates and items. To get an idea of what that means in practice, see: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/UI_LayoutEngine#Panels.2C_Templates_and_Items
2009-03-13 13:38:41 +00:00
/* items */
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
void uiItemO(uiLayout *layout, const char *name, int icon, const char *opname);
reduce operator lookups in the UI (could do 4 hash lookups per button).
2012-01-22 03:30:07 +00:00
void uiItemEnumO_ptr(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperatorType *ot,
reduce operator lookups in the UI (could do 4 hash lookups per button).
2012-01-22 03:30:07 +00:00
const char *name,
int icon,
const char *propname,
int value);
Enabled GCC -Wwrite-strings warning for CMake and replaced many 'char's for 'const char's,. Only one functional change where Transform orientations passed "" to BIF_createTransformOrientation() which could then have the value written into.
2010-12-03 17:05:21 +00:00
void uiItemEnumO(uiLayout *layout,
const char *opname,
const char *name,
int icon,
const char *propname,
int value);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* For use in cases where we have.
*/
fix for using uiItemIntO for an enum, added uiItemEnumO_value function.
2011-03-24 12:36:12 +00:00
void uiItemEnumO_value(uiLayout *layout,
const char *name,
int icon,
const char *opname,
const char *propname,
int value);
Enabled GCC -Wwrite-strings warning for CMake and replaced many 'char's for 'const char's,. Only one functional change where Transform orientations passed "" to BIF_createTransformOrientation() which could then have the value written into.
2010-12-03 17:05:21 +00:00
void uiItemEnumO_string(uiLayout *layout,
const char *name,
int icon,
const char *opname,
const char *propname,
const char *value);
Cleanup: Remove unneeded parameter A parameter was added during development, but it was not needed and was never removed. No functional changes.
2020-09-15 08:10:23 -06:00
void uiItemsEnumO(uiLayout *layout, const char *opname, const char *propname);
Enabled GCC -Wwrite-strings warning for CMake and replaced many 'char's for 'const char's,. Only one functional change where Transform orientations passed "" to BIF_createTransformOrientation() which could then have the value written into.
2010-12-03 17:05:21 +00:00
void uiItemBooleanO(uiLayout *layout,
const char *name,
int icon,
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
const char *opname,
const char *propname,
int value);
void uiItemIntO(uiLayout *layout,
const char *name,
int icon,
const char *opname,
const char *propname,
int value);
void uiItemFloatO(uiLayout *layout,
Enabled GCC -Wwrite-strings warning for CMake and replaced many 'char's for 'const char's,. Only one functional change where Transform orientations passed "" to BIF_createTransformOrientation() which could then have the value written into.
2010-12-03 17:05:21 +00:00
const char *name,
int icon,
const char *opname,
const char *propname,
float value);
void uiItemStringO(uiLayout *layout,
UI: replace UI_ITEM_O_RETURN_PROPS /w return arg Means we can have a version of this function that returns the button and avoids returning a struct that often isn't used.
2017-10-31 16:58:26 +11:00
const char *name,
int icon,
Fix #35262: assiging shortcuts from e.g. delete or selection mode menus did not work anymore. This was due to a bugfix to show missing shortcut keys for e.g. the mesh > vertices > separate menu. Both should work now.
2013-05-10 23:41:41 +00:00
const char *opname,
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
const char *propname,
Enabled GCC -Wwrite-strings warning for CMake and replaced many 'char's for 'const char's,. Only one functional change where Transform orientations passed "" to BIF_createTransformOrientation() which could then have the value written into.
2010-12-03 17:05:21 +00:00
const char *value);
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
UI: replace UI_ITEM_O_RETURN_PROPS /w return arg Means we can have a version of this function that returns the button and avoids returning a struct that often isn't used.
2017-10-31 16:58:26 +11:00
void uiItemFullO_ptr(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperatorType *ot,
UI: replace UI_ITEM_O_RETURN_PROPS /w return arg Means we can have a version of this function that returns the button and avoids returning a struct that often isn't used.
2017-10-31 16:58:26 +11:00
const char *name,
int icon,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
IDProperty *properties,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext context,
Cleanup: use typed enum for UI_ITEM_* flags Using an int lead to confusion with other flags often used with buttons. For e.g. these flags could be easily confused with uiItem::flag.
2023-07-29 15:06:33 +10:00
eUI_Item_Flag flag,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *r_opptr);
UI: replace UI_ITEM_O_RETURN_PROPS /w return arg Means we can have a version of this function that returns the button and avoids returning a struct that often isn't used.
2017-10-31 16:58:26 +11:00
void uiItemFullO(uiLayout *layout,
Cleanup: Clang-Tidy readability-inconsistent-declaration-parameter-name fix No functional changes
2020-09-04 20:59:13 +02:00
const char *opname,
UI: replace UI_ITEM_O_RETURN_PROPS /w return arg Means we can have a version of this function that returns the button and avoids returning a struct that often isn't used.
2017-10-31 16:58:26 +11:00
const char *name,
int icon,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
IDProperty *properties,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext context,
Cleanup: use typed enum for UI_ITEM_* flags Using an int lead to confusion with other flags often used with buttons. For e.g. these flags could be easily confused with uiItem::flag.
2023-07-29 15:06:33 +10:00
eUI_Item_Flag flag,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *r_opptr);
UI: Add UILayout.operator_menu_hold This is an operator button that opens a menu when the button is held.
2017-11-02 04:30:07 +11:00
void uiItemFullOMenuHold_ptr(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperatorType *ot,
UI: Add UILayout.operator_menu_hold This is an operator button that opens a menu when the button is held.
2017-11-02 04:30:07 +11:00
const char *name,
int icon,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
IDProperty *properties,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext context,
Cleanup: use typed enum for UI_ITEM_* flags Using an int lead to confusion with other flags often used with buttons. For e.g. these flags could be easily confused with uiItem::flag.
2023-07-29 15:06:33 +10:00
eUI_Item_Flag flag,
UI: Add UILayout.operator_menu_hold This is an operator button that opens a menu when the button is held.
2017-11-02 04:30:07 +11:00
const char *menu_id, /* extra menu arg. */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *r_opptr);
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
void uiItemR(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
const char *propname,
Cleanup: use typed enum for UI_ITEM_* flags Using an int lead to confusion with other flags often used with buttons. For e.g. these flags could be easily confused with uiItem::flag.
2023-07-29 15:06:33 +10:00
eUI_Item_Flag flag,
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
const char *name,
int icon);
UI: add UILayout.prop_popover_enum function Support for RNA enum buttons that activate popovers when clicked. This means we get useful tooltips, shortcuts and Ctrl-Wheel cycling over enum items. It also avoids inconvenient & slow access of enum values currently done via RNA type lookups on the type to get the name & icon to use for a regular popover button. Resolves T57738
2019-03-25 18:55:38 +11:00
void uiItemFullR(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
PropertyRNA *prop,
UI: add UILayout.prop_popover_enum function Support for RNA enum buttons that activate popovers when clicked. This means we get useful tooltips, shortcuts and Ctrl-Wheel cycling over enum items. It also avoids inconvenient & slow access of enum values currently done via RNA type lookups on the type to get the name & icon to use for a regular popover button. Resolves T57738
2019-03-25 18:55:38 +11:00
int index,
int value,
Cleanup: use typed enum for UI_ITEM_* flags Using an int lead to confusion with other flags often used with buttons. For e.g. these flags could be easily confused with uiItem::flag.
2023-07-29 15:06:33 +10:00
eUI_Item_Flag flag,
UI: add UILayout.prop_popover_enum function Support for RNA enum buttons that activate popovers when clicked. This means we get useful tooltips, shortcuts and Ctrl-Wheel cycling over enum items. It also avoids inconvenient & slow access of enum values currently done via RNA type lookups on the type to get the name & icon to use for a regular popover button. Resolves T57738
2019-03-25 18:55:38 +11:00
const char *name,
UI: Input Placeholders Optional inline hint describing the expected value of an input field. Pull Request: #112104
2023-10-12 11:44:08 -07:00
int icon,
const char *placeholder = nullptr);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Use a wrapper function since re-implementing all the logic in this function would be messy.
*/
UI: add UILayout.prop_popover_enum function Support for RNA enum buttons that activate popovers when clicked. This means we get useful tooltips, shortcuts and Ctrl-Wheel cycling over enum items. It also avoids inconvenient & slow access of enum values currently done via RNA type lookups on the type to get the name & icon to use for a regular popover button. Resolves T57738
2019-03-25 18:55:38 +11:00
void uiItemFullR_with_popover(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
PropertyRNA *prop,
UI: add UILayout.prop_popover_enum function Support for RNA enum buttons that activate popovers when clicked. This means we get useful tooltips, shortcuts and Ctrl-Wheel cycling over enum items. It also avoids inconvenient & slow access of enum values currently done via RNA type lookups on the type to get the name & icon to use for a regular popover button. Resolves T57738
2019-03-25 18:55:38 +11:00
int index,
int value,
Cleanup: use typed enum for UI_ITEM_* flags Using an int lead to confusion with other flags often used with buttons. For e.g. these flags could be easily confused with uiItem::flag.
2023-07-29 15:06:33 +10:00
eUI_Item_Flag flag,
UI: add UILayout.prop_popover_enum function Support for RNA enum buttons that activate popovers when clicked. This means we get useful tooltips, shortcuts and Ctrl-Wheel cycling over enum items. It also avoids inconvenient & slow access of enum values currently done via RNA type lookups on the type to get the name & icon to use for a regular popover button. Resolves T57738
2019-03-25 18:55:38 +11:00
const char *name,
int icon,
const char *panel_type);
RNA: add UILayout.prop_with_menu function Matches prop_with_popover, supporting menu types, useful if we want to control behavior of enum switching.
2019-03-25 20:31:06 +11:00
void uiItemFullR_with_menu(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
PropertyRNA *prop,
RNA: add UILayout.prop_with_menu function Matches prop_with_popover, supporting menu types, useful if we want to control behavior of enum switching.
2019-03-25 20:31:06 +11:00
int index,
int value,
Cleanup: use typed enum for UI_ITEM_* flags Using an int lead to confusion with other flags often used with buttons. For e.g. these flags could be easily confused with uiItem::flag.
2023-07-29 15:06:33 +10:00
eUI_Item_Flag flag,
RNA: add UILayout.prop_with_menu function Matches prop_with_popover, supporting menu types, useful if we want to control behavior of enum switching.
2019-03-25 20:31:06 +11:00
const char *name,
int icon,
const char *menu_type);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiItemEnumR_prop(
uiLayout *layout, const char *name, int icon, PointerRNA *ptr, PropertyRNA *prop, int value);
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
void uiItemEnumR(uiLayout *layout,
const char *name,
int icon,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
const char *propname,
int value);
RNA: avoid redundant property lookups in UI API
2018-08-24 11:44:28 +10:00
void uiItemEnumR_string_prop(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
PropertyRNA *prop,
RNA: avoid redundant property lookups in UI API
2018-08-24 11:44:28 +10:00
const char *value,
const char *name,
int icon);
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
void uiItemEnumR_string(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
const char *propname,
const char *value,
const char *name,
int icon);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiItemsEnumR(uiLayout *layout, PointerRNA *ptr, const char *propname);
RNA: avoid redundant property lookups in UI API
2018-08-24 11:44:28 +10:00
void uiItemPointerR_prop(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
PropertyRNA *prop,
PointerRNA *searchptr,
PropertyRNA *searchprop,
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
const char *name,
Cycles: Support adding Lightgroups from the object/world properties Currently, only Lightgroups that exist in the current view layer can be selected from object or world properties. The internal UI code already has support for search fields that accept unknown input, so I just added that to the API and use it for lightgroups. When a lightgroup is entered that does not exist in the current view layer (e.g. because it's completely new, because the view layer was switched or because it was deleted earlier), a new button next to it becomes active and adds it to the view layer when pressed. Differential Revision: https://developer.blender.org/D14540
2022-04-04 03:50:55 +02:00
int icon,
bool results_are_suggestions);
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
void uiItemPointerR(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *ptr,
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *searchptr,
Fix items in mode pie changing position by supporting more than 8 items in operator-enum pies Now a 'More' item is added to the pie when there are too many items. It opens a sub-pie that contains the remaining items. Note that this only touches operator-enum pies (like the object mode pie is), it is not a complete support for pies with more than 8 items. For this further design and code work would be needed, but this is too urgent to wait for that. This is a better fix for T46973, should definitely be applied for 2.77 release. Patch D1800 by myself with some edits by @campbellbarton, thanks!
2016-02-16 14:50:26 +01:00
const char *searchpropname,
const char *name,
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
int icon);
UI: Highlight Selected Item in View3D Mode Menu Allow the View3D "Mode" menu to highlight the currently-selected mode. Pull Request: https://projects.blender.org/blender/blender/pulls/112058
2023-10-11 19:27:02 +02:00
Cleanup: use doxygen doc-strings, spelling in comments
2023-10-12 09:22:34 +11:00
/**
* Create a list of enum items.
* \param active: an optional item to highlight.
*/
Fix items in mode pie changing position by supporting more than 8 items in operator-enum pies Now a 'More' item is added to the pie when there are too many items. It opens a sub-pie that contains the remaining items. Note that this only touches operator-enum pies (like the object mode pie is), it is not a complete support for pies with more than 8 items. For this further design and code work would be needed, but this is too urgent to wait for that. This is a better fix for T46973, should definitely be applied for 2.77 release. Patch D1800 by myself with some edits by @campbellbarton, thanks!
2016-02-16 14:50:26 +01:00
void uiItemsFullEnumO(uiLayout *layout,
const char *opname,
const char *propname,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
IDProperty *properties,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext context,
UI: Highlight Selected Item in View3D Mode Menu Allow the View3D "Mode" menu to highlight the currently-selected mode. Pull Request: https://projects.blender.org/blender/blender/pulls/112058
2023-10-11 19:27:02 +02:00
eUI_Item_Flag flag,
const int active = -1);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Create UI items for enum items in \a item_array.
*
* A version of #uiItemsFullEnumO that takes pre-calculated item array.
Cleanup: use doxygen doc-strings, spelling in comments
2023-10-12 09:22:34 +11:00
* \param active: if not -1, will highlight that item.
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
Fix items in mode pie changing position by supporting more than 8 items in operator-enum pies Now a 'More' item is added to the pie when there are too many items. It opens a sub-pie that contains the remaining items. Note that this only touches operator-enum pies (like the object mode pie is), it is not a complete support for pies with more than 8 items. For this further design and code work would be needed, but this is too urgent to wait for that. This is a better fix for T46973, should definitely be applied for 2.77 release. Patch D1800 by myself with some edits by @campbellbarton, thanks!
2016-02-16 14:50:26 +01:00
void uiItemsFullEnumO_items(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperatorType *ot,
PointerRNA ptr,
PropertyRNA *prop,
IDProperty *properties,
Cleanup (UI): Add/use type for operator context enum Adds a `wmOperatorCallContext` typedef for the existing `WM_OP_XXX` operator context enum. This adds type safety, allows the compiler to produce better warnings and helps understanding what a variable is for. Differential Revision: https://developer.blender.org/D13113 Reviewed by: Campbell Barton
2021-11-05 14:56:22 +01:00
wmOperatorCallContext context,
Cleanup: use typed enum for UI_ITEM_* flags Using an int lead to confusion with other flags often used with buttons. For e.g. these flags could be easily confused with uiItem::flag.
2023-07-29 15:06:33 +10:00
eUI_Item_Flag flag,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const EnumPropertyItem *item_array,
UI: Highlight Selected Item in View3D Mode Menu Allow the View3D "Mode" menu to highlight the currently-selected mode. Pull Request: https://projects.blender.org/blender/blender/pulls/112058
2023-10-11 19:27:02 +02:00
int totitem,
int active = -1);
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiPropertySplitWrapper {
UI: (Internal) utility for more controllable property split layout Adds a wrapper-struct to create and return the three layouts required for the propery split layout (i.e. `UILayout.use_property_split`). This gives more flexibility for special treatment. E.g. needed for adding the arrow icon buttons when there is a hierarchy of nodes to be represented in the material properties (needs inserting in the text column to not offset the split layout). This commit also makes use of the utility for `uiItemL_respect_property_split()`.
2020-04-27 16:43:36 +02:00
uiLayout *label_column;
uiLayout *property_row;
uiLayout *decorate_column;
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
UI: (Internal) utility for more controllable property split layout Adds a wrapper-struct to create and return the three layouts required for the propery split layout (i.e. `UILayout.use_property_split`). This gives more flexibility for special treatment. E.g. needed for adding the arrow icon buttons when there is a hierarchy of nodes to be represented in the material properties (needs inserting in the text column to not offset the split layout). This commit also makes use of the utility for `uiItemL_respect_property_split()`.
2020-04-27 16:43:36 +02:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Normally, we handle the split layout in #uiItemFullR(), but there are other cases where the
* logic is needed. Ideally, #uiItemFullR() could just call this, but it currently has too many
* special needs.
*/
UI: (Internal) utility for more controllable property split layout Adds a wrapper-struct to create and return the three layouts required for the propery split layout (i.e. `UILayout.use_property_split`). This gives more flexibility for special treatment. E.g. needed for adding the arrow icon buttons when there is a hierarchy of nodes to be represented in the material properties (needs inserting in the text column to not offset the split layout). This commit also makes use of the utility for `uiItemL_respect_property_split()`.
2020-04-27 16:43:36 +02:00
uiPropertySplitWrapper uiItemPropertySplitWrapperCreate(uiLayout *parent_layout);
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
void uiItemL(uiLayout *layout, const char *name, int icon); /* label */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiBut *uiItemL_ex(uiLayout *layout, const char *name, int icon, bool highlight, bool redalert);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Helper to add a label and creates a property split layout if needed.
*/
UI: Allow label for Template-ID (respecting property split layout) Adds a `text` parameter to `bpy.types.uiLayout.template_ID()` which causes a label to be added, as usual. Adding the label also makes the template respect the `bpy.types.uiLayout.use_property_split` option. Also fixes wrong layout being used in the template-ID, although I think that didn't cause issues in practice. Sergey requested this for usage in the Movie Clip Editor.
2019-11-25 19:41:30 +01:00
uiLayout *uiItemL_respect_property_split(uiLayout *layout, const char *text, int icon);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Label icon for dragging.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiItemLDrag(uiLayout *layout, PointerRNA *ptr, const char *name, int icon);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Menu.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiItemM_ptr(uiLayout *layout, MenuType *mt, const char *name, int icon);
Cleanup: comment line length (editors) Prevents clang-format wrapping text before comments.
2019-01-15 23:24:20 +11:00
void uiItemM(uiLayout *layout, const char *menuname, const char *name, int icon);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Menu contents.
*/
Cleanup: comment line length (editors) Prevents clang-format wrapping text before comments.
2019-01-15 23:24:20 +11:00
void uiItemMContents(uiLayout *layout, const char *menuname);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/* Decorators. */
/**
* Insert a decorator item for a button with the same property as \a prop.
* To force inserting a blank dummy element, NULL can be passed for \a ptr and \a prop.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiItemDecoratorR_prop(uiLayout *layout, PointerRNA *ptr, PropertyRNA *prop, int index);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Insert a decorator item for a button with the same property as \a prop.
* To force inserting a blank dummy element, NULL can be passed for \a ptr and \a propname.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiItemDecoratorR(uiLayout *layout, PointerRNA *ptr, const char *propname, int index);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/** Value item */
Cleanup: comment line length (editors) Prevents clang-format wrapping text before comments.
2019-01-15 23:24:20 +11:00
void uiItemV(uiLayout *layout, const char *name, int icon, int argval);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/** Separator item */
Cleanup: comment line length (editors) Prevents clang-format wrapping text before comments.
2019-01-15 23:24:20 +11:00
void uiItemS(uiLayout *layout);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/** Separator item */
Add new factor parameter to layout.separator() The new parameter allows to define the scale of the space.
2018-11-02 16:32:31 +01:00
void uiItemS_ex(uiLayout *layout, float factor);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/** Flexible spacing. */
Cleanup: comment line length (editors) Prevents clang-format wrapping text before comments.
2019-01-15 23:24:20 +11:00
void uiItemSpacer(uiLayout *layout);
UI * Headers and menus can now be created in python. * Replaced the uiMenuItem functions to create menus with equivalent uiItem functions using a layout, removing duplicated code. * More uiItem functions are now exposed to python. * The text editor header, panels and one of its menus are now created in space_text.py. * Buttons window data context icon new changes depending on active object. Issues * Icons are not wrapped yet, hardcoded ints at the moment. * The ID browse template is unfinished.
2009-04-22 18:39:44 +00:00
UI: add progress indicator variations & RNA API Add pie and ring styles of progress indicators. Exposes progress bar to the Python API and adds a "type" property to allow style variation. This can be used for scripts & add-ons to show progress in the UI. Ref !109882. Co-authored-by: Campbell Barton <campbell@blender.org>
2023-07-12 13:18:06 +10:00
void uiItemProgressIndicator(uiLayout *layout,
const char *text,
float factor,
enum eButProgressType progress_type);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/* popover */
UI: Initial popover support for panels - UILayout.popover(.. panel_type ..) A single panel - UILayout.popover_group(.. panel categories ..) Expands all panels matching args. Currently used in the topbar for redo and paint options.
2018-04-22 17:16:39 +02:00
void uiItemPopoverPanel_ptr(
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiLayout *layout, const bContext *C, PanelType *pt, const char *name, int icon);
void uiItemPopoverPanel(
uiLayout *layout, const bContext *C, const char *panel_type, const char *name, int icon);
UI: Initial popover support for panels - UILayout.popover(.. panel_type ..) A single panel - UILayout.popover_group(.. panel categories ..) Expands all panels matching args. Currently used in the topbar for redo and paint options.
2018-04-22 17:16:39 +02:00
void uiItemPopoverPanelFromGroup(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bContext *C,
UI: Initial popover support for panels - UILayout.popover(.. panel_type ..) A single panel - UILayout.popover_group(.. panel categories ..) Expands all panels matching args. Currently used in the topbar for redo and paint options.
2018-04-22 17:16:39 +02:00
int space_id,
int region_id,
const char *context,
const char *category);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Level items.
*/
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
void uiItemMenuF(uiLayout *layout, const char *name, int icon, uiMenuCreateFunc func, void *arg);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Version of #uiItemMenuF that free's `argN`.
*/
UI: add uiItemMenuFN which frees it's argument
2018-10-30 10:46:29 +11:00
void uiItemMenuFN(uiLayout *layout, const char *name, int icon, uiMenuCreateFunc func, void *argN);
UI: Support setting operator properties for `UILayout.operator_menu_enum()` `UILayout.operator_menu_enum()` now returns the operator properties, just like `UILayout.operator()`. This makes it possible to set options for the operator displayed in the menu. In C it can be done through the new `uiItemMenuEnumFullO()` or `uiItemMenuEnumFullO_ptr()`. It's reasonable to have this, probably just a small thing never bothered to add. D10912 could use it, the following comment can be addressed now too: https://developer.blender.org/diffusion/B/browse/master/source/blender/editors/space_nla/nla_buttons.c$583-586
2021-06-29 17:20:33 +02:00
void uiItemMenuEnumFullO_ptr(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const bContext *C,
wmOperatorType *ot,
UI: Support setting operator properties for `UILayout.operator_menu_enum()` `UILayout.operator_menu_enum()` now returns the operator properties, just like `UILayout.operator()`. This makes it possible to set options for the operator displayed in the menu. In C it can be done through the new `uiItemMenuEnumFullO()` or `uiItemMenuEnumFullO_ptr()`. It's reasonable to have this, probably just a small thing never bothered to add. D10912 could use it, the following comment can be addressed now too: https://developer.blender.org/diffusion/B/browse/master/source/blender/editors/space_nla/nla_buttons.c$583-586
2021-06-29 17:20:33 +02:00
const char *propname,
const char *name,
int icon,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *r_opptr);
UI: Support setting operator properties for `UILayout.operator_menu_enum()` `UILayout.operator_menu_enum()` now returns the operator properties, just like `UILayout.operator()`. This makes it possible to set options for the operator displayed in the menu. In C it can be done through the new `uiItemMenuEnumFullO()` or `uiItemMenuEnumFullO_ptr()`. It's reasonable to have this, probably just a small thing never bothered to add. D10912 could use it, the following comment can be addressed now too: https://developer.blender.org/diffusion/B/browse/master/source/blender/editors/space_nla/nla_buttons.c$583-586
2021-06-29 17:20:33 +02:00
void uiItemMenuEnumFullO(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const bContext *C,
UI: Support setting operator properties for `UILayout.operator_menu_enum()` `UILayout.operator_menu_enum()` now returns the operator properties, just like `UILayout.operator()`. This makes it possible to set options for the operator displayed in the menu. In C it can be done through the new `uiItemMenuEnumFullO()` or `uiItemMenuEnumFullO_ptr()`. It's reasonable to have this, probably just a small thing never bothered to add. D10912 could use it, the following comment can be addressed now too: https://developer.blender.org/diffusion/B/browse/master/source/blender/editors/space_nla/nla_buttons.c$583-586
2021-06-29 17:20:33 +02:00
const char *opname,
UI: avoid double operator type lookup
2017-10-31 12:44:41 +11:00
const char *propname,
Fix #35262: assiging shortcuts from e.g. delete or selection mode menus did not work anymore. This was due to a bugfix to show missing shortcut keys for e.g. the mesh > vertices > separate menu. Both should work now.
2013-05-10 23:41:41 +00:00
const char *name,
UI: Support setting operator properties for `UILayout.operator_menu_enum()` `UILayout.operator_menu_enum()` now returns the operator properties, just like `UILayout.operator()`. This makes it possible to set options for the operator displayed in the menu. In C it can be done through the new `uiItemMenuEnumFullO()` or `uiItemMenuEnumFullO_ptr()`. It's reasonable to have this, probably just a small thing never bothered to add. D10912 could use it, the following comment can be addressed now too: https://developer.blender.org/diffusion/B/browse/master/source/blender/editors/space_nla/nla_buttons.c$583-586
2021-06-29 17:20:33 +02:00
int icon,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *r_opptr);
Fix #35262: assiging shortcuts from e.g. delete or selection mode menus did not work anymore. This was due to a bugfix to show missing shortcut keys for e.g. the mesh > vertices > separate menu. Both should work now.
2013-05-10 23:41:41 +00:00
void uiItemMenuEnumO(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const bContext *C,
Fix #35262: assiging shortcuts from e.g. delete or selection mode menus did not work anymore. This was due to a bugfix to show missing shortcut keys for e.g. the mesh > vertices > separate menu. Both should work now.
2013-05-10 23:41:41 +00:00
const char *opname,
const char *propname,
UI: avoid double operator type lookup
2017-10-31 12:44:41 +11:00
const char *name,
int icon);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void uiItemMenuEnumR_prop(
uiLayout *layout, PointerRNA *ptr, PropertyRNA *prop, const char *name, int icon);
use 'const char *' by default with RNA functions except when the value is flagged as PROP_THICK_WRAP. Also use const char in many other parts of blenders code. Currently this gives warnings for setting operator id, label and description since these are an exception and allocated beforehand.
2010-11-17 09:45:45 +00:00
void uiItemMenuEnumR(
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiLayout *layout, PointerRNA *ptr, const char *propname, const char *name, int icon);
UI: Support Displaying Enums as Tabs Adds `uiLayout.prop_tabs_enum(data, property, icon_only)` to BPY.
2018-10-29 21:20:58 +01:00
void uiItemTabsEnumR_prop(uiLayout *layout,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bContext *C,
PointerRNA *ptr,
PropertyRNA *prop,
PointerRNA *ptr_highlight,
PropertyRNA *prop_highlight,
UI: Support Displaying Enums as Tabs Adds `uiLayout.prop_tabs_enum(data, property, icon_only)` to BPY.
2018-10-29 21:20:58 +01:00
bool icon_only);
2.5: UI Layout Engine, initial code. * As a test, used by: * Object buttons, tried to make it match the mockup. * Text window header. * Text window properties panel. * Panel interaction with view2d is still problematic, need to make this work properly still. * Templates are very basic, the ones there are simple but already can follow the object buttons mockup quite closely. * It's based on a three level system: panels, templates and items. To get an idea of what that means in practice, see: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/UI_LayoutEngine#Panels.2C_Templates_and_Items
2009-03-13 13:38:41 +00:00
UI: add back Layout.introspect Add back this function, removed 2e14b7fb9770b. Useful for checking operators used in menus.
2020-09-01 15:23:55 +10:00
/* Only for testing, inspecting layouts. */
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Evaluate layout items as a Python dictionary.
*/
UI: add back Layout.introspect Add back this function, removed 2e14b7fb9770b. Useful for checking operators used in menus.
2020-09-01 15:23:55 +10:00
const char *UI_layout_introspect(uiLayout *layout);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Helper to add a big icon and create a split layout for alert popups.
* Returns the layout to place further items into the alert box.
*/
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
uiLayout *uiItemsAlertBox(uiBlock *block, int size, eAlertIcon icon);
UI: Alert Dialog Helper Function Shared helper function to create a split layout with an alert icon for popup dialogs. Differential Revision: https://developer.blender.org/D9486 Reviewed by Julian Eisel
2020-12-06 11:17:51 -08:00
RNA/UI - Reset Settings to Default Values Added a new operator for properties which resets RNA-based settings to their 'default' values, as defined in RNA. This currently only works for floats, ints, enums, and booleans (strings and pointers still need to be implemented). The current extensions to the RNA API that I've made here seem a bit excessive, and can be toned down if necessary. In short, I've just added accessor functions for the default-values of the property definitions. For this to be really useful, many properties in RNA will need to get defaults defined, since the current defaults for quite a few properties tested were less than ideal.
2009-12-17 10:47:55 +00:00
/* UI Operators */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiDragColorHandle {
GSOC 2013 paint Yep, at last it's here! There are a few minor issues remaining but development can go on in master after discussion at blender institute. For full list of features see: http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.72/Painting Thanks to Sergey and Campbell for the extensive review and to the countless artists that have given their input and reported issues during development.
2014-07-21 12:02:05 +02:00
float color[3];
bool gamma_corrected;
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
GSOC 2013 paint Yep, at last it's here! There are a few minor issues remaining but development can go on in master after discussion at blender institute. For full list of features see: http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.72/Painting Thanks to Sergey and Campbell for the extensive review and to the countless artists that have given their input and reported issues during development.
2014-07-21 12:02:05 +02:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void ED_operatortypes_ui();
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \brief User Interface Keymap
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void ED_keymap_ui(wmKeyConfig *keyconf);
void ED_dropboxes_ui();
void ED_uilisttypes_ui();
Add User Interface keymap (no items yet) Needed to allow modal UI keymaps, but I'm sure we'll need this more often in future. First item will be modal eyedropper keymap coming in a following commit.
2016-02-29 17:40:19 +01:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_drop_color_copy(bContext *C, wmDrag *drag, wmDropBox *drop);
bool UI_drop_color_poll(bContext *C, wmDrag *drag, const wmEvent *event);
ClangFormat: apply to source, most of intern Apply clang format as proposed in T53211. For details on usage and instructions for migrating branches without conflicts, see: https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:17:24 +02:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_context_copy_to_selected_list(bContext *C,
PointerRNA *ptr,
PropertyRNA *prop,
ListBase *r_lb,
UI: initial support for UI editing selected items Add basic support (holding Alt) to edit all selected objects/bones/sequences.
2015-05-11 15:32:43 +10:00
bool *r_use_path_from_id,
char **r_path);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_context_copy_to_selected_check(PointerRNA *ptr,
PointerRNA *ptr_link,
PropertyRNA *prop,
UI: deduplicate code for Copy To Selected and Alt-button tweaking This resolves an old TODO to deduplicate code in copy_to_selected_button & ui_selectcontext_begin. This is also in hindsight of adding id-property support [incl. Geometry Nodes modifier properties] for this in the next commit. No behavior change expected here. ref T93983 & D13573
2021-12-16 13:03:39 +01:00
const char *path,
bool use_path_from_id,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
PointerRNA *r_ptr,
PropertyRNA **r_prop);
UI: initial support for UI editing selected items Add basic support (holding Alt) to edit all selected objects/bones/sequences.
2015-05-11 15:32:43 +10:00
2.5: File browse button in ui layouts now works, e.g. for render output path or fluidsim path.
2009-07-28 18:51:06 +00:00
/* Helpers for Operators */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiBut *UI_context_active_but_get(const bContext *C);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Version of #UI_context_active_get() that uses the result of #CTX_wm_menu()
* if set. Does not traverse into parent menus, which may be wanted in some
* cases.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiBut *UI_context_active_but_get_respect_menu(const bContext *C);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Version of #UI_context_active_but_get that also returns RNA property info.
* Helper function for insert keyframe, reset to default, etc operators.
*
* \return active button, NULL if none found or if it doesn't contain valid RNA data.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiBut *UI_context_active_but_prop_get(const bContext *C,
PointerRNA *r_ptr,
PropertyRNA **r_prop,
Cleanup: use return argument prefix
2016-06-24 10:05:09 +10:00
int *r_index);
Fix #105726: Driver Editing Popover Menu Closing Allow specifying a specific region to check for active button. This is required in some circumstances, like Driver Popover. Pull Request: https://projects.blender.org/blender/blender/pulls/105746
2023-03-14 16:27:23 +01:00
/**
* As above, but for a specified region.
*
* \return active button, NULL if none found or if it doesn't contain valid RNA data.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiBut *UI_region_active_but_prop_get(const ARegion *region,
PointerRNA *r_ptr,
PropertyRNA **r_prop,
Fix #105726: Driver Editing Popover Menu Closing Allow specifying a specific region to check for active button. This is required in some circumstances, like Driver Popover. Pull Request: https://projects.blender.org/blender/blender/pulls/105746
2023-03-14 16:27:23 +01:00
int *r_index);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_context_active_but_prop_handle(bContext *C, bool handle_undo);
void UI_context_active_but_clear(bContext *C, wmWindow *win, ARegion *region);
Fix T76794: Number button cursor overrides eyedropper cursor Pressing 'E' over a number button to pick a distance was keeping left-right arrows instead of using the eye-dropper cursor. Workaround this by clearing the active button before setting the cursor.
2020-05-20 22:04:59 +10:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
wmOperator *UI_context_active_operator_get(const bContext *C);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Helper function for insert keyframe, reset to default, etc operators.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_context_update_anim_flag(const bContext *C);
void UI_context_active_but_prop_get_filebrowser(const bContext *C,
PointerRNA *r_ptr,
PropertyRNA **r_prop,
Fix T77171: File selector doesn't tag preferences to be saved
2020-06-11 17:24:00 +10:00
bool *r_is_undo,
bool *r_is_userdef);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* For new/open operators.
Cleanup: move doc-strings into headers, remove duplicates In some cases move implementation details into the function body.
2023-03-29 14:16:31 +11:00
*
* This is for browsing and editing the ID-blocks used.
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_context_active_but_prop_get_templateID(bContext *C,
PointerRNA *r_ptr,
PropertyRNA **r_prop);
ID *UI_context_active_but_get_tab_ID(bContext *C);
2.5: Added basic insert/remove keyframes from UI buttons. - I key over a button inserts a keyframe. - Alt+I removes a keyframe. - With right mouse button a menu with these options pops up. - Buttons are colored green if the property is animated, yellow if it is on a keyframe. I followed the colors from the UI mockups, but the flicker on keyframes seems too distracting in practice? - This only works for properties on the ID itself at the moment, path callbacks need to be filled in for all structs but mesh still. - It doesn't work when you're over a related label, that needs to be made to work. - I made it insert keyframes outside of any keyingset. Not sure how this is supposed to integrate?
2009-04-03 23:30:32 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiBut *UI_region_active_but_get(const ARegion *region);
uiBut *UI_region_but_find_rect_over(const ARegion *region, const rcti *rect_px);
uiBlock *UI_region_block_find_mouse_over(const ARegion *region, const int xy[2], bool only_clip);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Try to find a search-box region opened from a button in \a button_region.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
ARegion *UI_region_searchbox_region_get(const ARegion *button_region);
UI: change tool-tips to be stored in the screen Move timer and tip out of button code, now the only requests a tooltip, passing a creation callback to run. Needed for manipulators in 2.8, also helps de-duplicate logic - since we never want multiple tool-tips showing at once.
2018-01-25 16:17:25 +11:00
Cleanup: use doxygen links to struct members
2022-04-05 08:00:20 +10:00
/** #uiFontStyle.align */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
enum eFontStyle_Align {
UI: refactor layout vars out of uiFontStyle Word wrap and alignment layout args only used by UI_fontstyle_draw were vars in uiFontStyle. These were written to before drawing, so better pass as an argument. Pass uiFontStyle & uiWidgetColors as const args.
2019-01-04 09:58:03 +11:00
UI_STYLE_TEXT_LEFT = 0,
UI_STYLE_TEXT_CENTER = 1,
Cleanup: commas at the end of enums Without this clang-format may wrap them onto a single line.
2019-01-15 23:57:49 +11:00
UI_STYLE_TEXT_RIGHT = 2,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
UI: refactor layout vars out of uiFontStyle Word wrap and alignment layout args only used by UI_fontstyle_draw were vars in uiFontStyle. These were written to before drawing, so better pass as an argument. Pass uiFontStyle & uiWidgetColors as const args.
2019-01-04 09:58:03 +11:00
struct uiFontStyleDraw_Params {
eFontStyle_Align align;
uint word_wrap : 1;
};
2.5 WIP commit for UI drawing. - Hooked up Diego's new Font API - Added Style definitions for fonts, currently it uses a different font for panel titles to show it. - Styles are in Userdef now too, still not finished - Userdef "DPI" will offer global control over font size, to match monitor size/resolution. It's meant to scale widgets and headers too btw, later. - Lots of code removed for old fonts, but that's unfinished. On todo: too much to mention, will continue happily tomorrow!
2009-04-09 18:11:18 +00:00
/* Styled text draw */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_fontstyle_set(const uiFontStyle *fs);
void UI_fontstyle_draw_ex(const uiFontStyle *fs,
const rcti *rect,
UI: cleanup UI_fontstyle_string_width, UI_draw_string Both were maked as temp, but used often. Now pass uiFontStyle to both, rename UI_draw_string to UI_fontstyle_draw_simple, since its a variant of UI_fontstyle_draw that skips shadow, align... etc.
2015-01-20 14:25:39 +11:00
const char *str,
Revert "BLI: Refactor vector types & functions to use templates" Includes unwanted changes This reverts commit 46e049d0ce2bce2f53ddc41a0dbbea2969d00a5d.
2022-01-12 12:49:36 +01:00
size_t str_len,
UI: refactor layout vars out of uiFontStyle Word wrap and alignment layout args only used by UI_fontstyle_draw were vars in uiFontStyle. These were written to before drawing, so better pass as an argument. Pass uiFontStyle & uiWidgetColors as const args.
2019-01-04 09:58:03 +11:00
const uchar col[4],
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const uiFontStyleDraw_Params *fs_params,
Cleanup: pass font drawing x/y offset arguments as int's Internally these values are ints.
2020-04-14 18:41:23 +10:00
int *r_xofs,
UI: improve menu search with dimmed menu prefix - Show dimmed text for the menu entries leading up to the menu item. - Show icons between the menu text and menu item. - Use unicode right pointing triangle instead of arrow.
2020-04-14 18:46:13 +10:00
int *r_yofs,
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
ResultBLF *r_info);
Revert "BLI: Refactor vector types & functions to use templates" Includes unwanted changes This reverts commit 46e049d0ce2bce2f53ddc41a0dbbea2969d00a5d.
2022-01-12 12:49:36 +01:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_fontstyle_draw(const uiFontStyle *fs,
const rcti *rect,
Merge branch 'master' into blender2.8
2018-07-09 06:40:47 +02:00
const char *str,
Revert "BLI: Refactor vector types & functions to use templates" Includes unwanted changes This reverts commit 46e049d0ce2bce2f53ddc41a0dbbea2969d00a5d.
2022-01-12 12:49:36 +01:00
size_t str_len,
UI: refactor layout vars out of uiFontStyle Word wrap and alignment layout args only used by UI_fontstyle_draw were vars in uiFontStyle. These were written to before drawing, so better pass as an argument. Pass uiFontStyle & uiWidgetColors as const args.
2019-01-04 09:58:03 +11:00
const uchar col[4],
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const uiFontStyleDraw_Params *fs_params);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Drawn same as above, but at 90 degree angle.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_fontstyle_draw_rotated(const uiFontStyle *fs,
const rcti *rect,
Merge branch 'master' into blender2.8
2018-07-09 06:40:47 +02:00
const char *str,
UI: refactor layout vars out of uiFontStyle Word wrap and alignment layout args only used by UI_fontstyle_draw were vars in uiFontStyle. These were written to before drawing, so better pass as an argument. Pass uiFontStyle & uiWidgetColors as const args.
2019-01-04 09:58:03 +11:00
const uchar col[4]);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Similar to #UI_fontstyle_draw
* but ignore alignment, shadow & no clipping rect.
*
* For drawing on-screen labels.
*/
Merge branch 'master' into blender2.8
2018-07-09 06:40:47 +02:00
void UI_fontstyle_draw_simple(
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const uiFontStyle *fs, float x, float y, const char *str, const uchar col[4]);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Same as #UI_fontstyle_draw but draw a colored backdrop.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_fontstyle_draw_simple_backdrop(const uiFontStyle *fs,
Cleanup: remove redundant includes
2015-07-11 02:49:04 +10:00
float x,
float y,
const char *str,
Fix missing conversion of uchar color to float Decided to just pass float [4] args, so no type conversion is needed at all.
2016-11-22 14:40:57 +01:00
const float col_fg[4],
const float col_bg[4]);
2.5 WIP commit for UI drawing. - Hooked up Diego's new Font API - Added Style definitions for fonts, currently it uses a different font for panel titles to show it. - Styles are in Userdef now too, still not finished - Userdef "DPI" will offer global control over font size, to match monitor size/resolution. It's meant to scale widgets and headers too btw, later. - Lots of code removed for old fonts, but that's unfinished. On todo: too much to mention, will continue happily tomorrow!
2009-04-09 18:11:18 +00:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int UI_fontstyle_string_width(const uiFontStyle *fs, const char *str) ATTR_WARN_UNUSED_RESULT
ATTR_NONNULL(1, 2);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Return the width of `str` with the spacing & kerning of `fs` with `aspect`
* (representing #uiBlock.aspect) applied.
*
* When calculating text width, the UI layout logic calculate widths without scale,
* only applying scale when drawing. This causes problems for fonts since kerning at
* smaller sizes often makes them wider than a scaled down version of the larger text.
* Resolve this by calculating the text at the on-screen size,
Cleanup: use '#' prefix for issues instead of 'T' Match the convention from Gitea instead of Phabricator's T for tasks.
2023-02-12 14:37:16 +11:00
* returning the result scaled back to 1:1. See #92361.
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int UI_fontstyle_string_width_with_block_aspect(const uiFontStyle *fs,
Fix T92361: Zooming nodes clips text labels While c7d94a7827a5be9343eea22a9638bb059f185206 exposed this bug, this was caused by text widths being calculated without taking the zoom level into account since drawing at a smaller size is often wider than the width of the larger text scaled by the zoom.
2021-10-26 00:10:18 +11:00
const char *str,
Cleanup: remove redundant const qualifiers for POD types MSVC used to warn about const mismatch for arguments passed by value. Remove these as newer versions of MSVC no longer show this warning.
2022-01-07 11:38:08 +11:00
float aspect) ATTR_WARN_UNUSED_RESULT
Fix T92361: Zooming nodes clips text labels While c7d94a7827a5be9343eea22a9638bb059f185206 exposed this bug, this was caused by text widths being calculated without taking the zoom level into account since drawing at a smaller size is often wider than the width of the larger text scaled by the zoom.
2021-10-26 00:10:18 +11:00
ATTR_NONNULL(1, 2);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
int UI_fontstyle_height_max(const uiFontStyle *fs);
Fix UI glitches drawing text at different sizes Font height was ignoring DPI in some cases (camera-name & eyedropper).
2015-01-20 15:48:40 +11:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Triangle 'icon' for panel header and other cases.
*/
Immediate Mode: area.c and UI_draw_icon_tri, ui_draw_anti_tria Note: This makes the jittering to not work :/ @merwin, would you know how to use gpuMatrixBegin2D for this case? I think it must be the reason behind the lack of jittering. But I couldn't get it to work (the 2D shader is asking for a 3D Matrix). Part of T49043
2017-02-14 13:00:22 +01:00
void UI_draw_icon_tri(float x, float y, char dir, const float[4]);
Holiday coding log :) Nice formatted version (pictures soon): http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.66/Usability Short list of main changes: - Transparent region option (over main region), added code to blend in/out such panels. - Min size window now 640 x 480 - Fixed DPI for ui - lots of cleanup and changes everywhere. Icon image need correct size still, layer-in-use icon needs remake. - Macbook retina support, use command line --no-native-pixels to disable it - Timeline Marker label was drawing wrong - Trackpad and magic mouse: supports zoom (hold ctrl) - Fix for splash position: removed ghost function and made window size update after creation immediate - Fast undo buffer save now adds UI as well. Could be checked for regular file save even... Quit.blend and temp file saving use this now. - Dixed filename in window on reading quit.blend or temp saves, and they now add a warning in window title: "(Recovered)" - New Userpref option "Keep Session" - this always saves quit.blend, and loads on start. This allows keeping UI and data without actual saves, until you actually save. When you load startup.blend and quit, it recognises the quit.blend as a startup (no file name in header) - Added 3D view copy/paste buffers (selected objects). Shortcuts ctrl-c, ctrl-v (OSX, cmd-c, cmd-v). Coded partial file saving for it. Could be used for other purposes. Todo: use OS clipboards. - User preferences (themes, keymaps, user settings) now can be saved as a separate file. Old option is called "Save Startup File" the new one "Save User Settings". To visualise this difference, the 'save startup file' button has been removed from user preferences window. That option is available as CTRL+U and in File menu still. - OSX: fixed bug that stopped giving mouse events outside window. This also fixes "Continuous Grab" for OSX. (error since 2009)
2012-12-12 18:58:11 +00:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/**
* Read a style (without any scaling applied).
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const uiStyle *UI_style_get(); /* use for fonts etc */
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/**
* Read a style (with the current DPI applied).
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const uiStyle *UI_style_get_dpi();
Holiday coding log :) Nice formatted version (pictures soon): http://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.66/Usability Short list of main changes: - Transparent region option (over main region), added code to blend in/out such panels. - Min size window now 640 x 480 - Fixed DPI for ui - lots of cleanup and changes everywhere. Icon image need correct size still, layer-in-use icon needs remake. - Macbook retina support, use command line --no-native-pixels to disable it - Timeline Marker label was drawing wrong - Trackpad and magic mouse: supports zoom (hold ctrl) - Fix for splash position: removed ghost function and made window size update after creation immediate - Fast undo buffer save now adds UI as well. Could be checked for regular file save even... Quit.blend and temp file saving use this now. - Dixed filename in window on reading quit.blend or temp saves, and they now add a warning in window title: "(Recovered)" - New Userpref option "Keep Session" - this always saves quit.blend, and loads on start. This allows keeping UI and data without actual saves, until you actually save. When you load startup.blend and quit, it recognises the quit.blend as a startup (no file name in header) - Added 3D view copy/paste buffers (selected objects). Shortcuts ctrl-c, ctrl-v (OSX, cmd-c, cmd-v). Coded partial file saving for it. Could be used for other purposes. Todo: use OS clipboards. - User preferences (themes, keymaps, user settings) now can be saved as a separate file. Old option is called "Save Startup File" the new one "Save User Settings". To visualise this difference, the 'save startup file' button has been removed from user preferences window. That option is available as CTRL+U and in File menu still. - OSX: fixed bug that stopped giving mouse events outside window. This also fixes "Continuous Grab" for OSX. (error since 2009)
2012-12-12 18:58:11 +00:00
many functions in blender are not marked static but should be. most local modifier,GPU,ImBuf and Interface functions are now static. also fixed an error were the fluid modifier definition and the header didnt have the same number of args.
2011-02-13 14:16:36 +00:00
/* linker workaround ack! */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_template_fix_linking();
2.5 WIP commit for UI drawing. - Hooked up Diego's new Font API - Added Style definitions for fonts, currently it uses a different font for panel titles to show it. - Styles are in Userdef now too, still not finished - Userdef "DPI" will offer global control over font size, to match monitor size/resolution. It's meant to scale widgets and headers too btw, later. - Lots of code removed for old fonts, but that's unfinished. On todo: too much to mention, will continue happily tomorrow!
2009-04-09 18:11:18 +00:00
Context menu 'Edit Source' operator no longer needs to be enabled as a build option, improved this so the python file:line lookups are only done when the operator runs (previously this was done for every button, every draw when the build option was enabled). Perhaps this should be hidden when not running with --debug, easy to change.
2011-10-23 04:13:56 +00:00
/* UI_OT_editsource helpers */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_editsource_enable_check();
Context menu 'Edit Source' operator no longer needs to be enabled as a build option, improved this so the python file:line lookups are only done when the operator runs (previously this was done for every button, every draw when the build option was enabled). Perhaps this should be hidden when not running with --debug, easy to change.
2011-10-23 04:13:56 +00:00
void UI_editsource_active_but_test(uiBut *but);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Remove the editsource data for \a old_but and reinsert it for \a new_but. Use when the button
* was reallocated, e.g. to have a new type (#ui_but_change_type()).
*/
Fix failing "Edit Source" (asserts) while number slider was visible E.g. steps to reproduce: * Enter Vertex Paint mode * In the tool settings, right-click > "Edit Source" When creating a number slider via `layout.prop(..., slider=True)`, the UI code would reallocate the number button to be a number-slider button. That's because we now actually have different button data-structures for these (see e6f0b60c2e911). The edit source code stored data based on the button pointers, which didn't get updated after changing the type. The fix just adds this updating.
2021-02-18 16:33:00 +01:00
void UI_editsource_but_replace(const uiBut *old_but, uiBut *new_but);
Context menu 'Edit Source' operator no longer needs to be enabled as a build option, improved this so the python file:line lookups are only done when the operator runs (previously this was done for every button, every draw when the build option was enabled). Perhaps this should be hidden when not running with --debug, easy to change.
2011-10-23 04:13:56 +00:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Adjust the view so the rectangle of \a but is in view, with some extra margin.
*
* It's important that this is only executed after buttons received their final #uiBut.rect. E.g.
* #UI_panels_end() modifies them, so if that is executed, this function must not be called before
* it.
*
* \param region: The region the button is placed in. Make sure this is actually the one the button
* is placed in, not just the context region.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_but_ensure_in_view(const bContext *C, ARegion *region, const uiBut *but);
UI: Auto-scroll to keep active text buttons in view If a text button is activated that is not in view (i.e. scrolled away), the scrolling will now be adjusted to have it in view (with some small additional margin). While entering text, the view may also be updated should the button move out of view, for whatever reason. For the most part, this feature shouldn't be needed and won't kick in, except when a clicked on text button is partially out of view or very close to the region edge. It's however quite important for the previously committed feature, that is, pressing Ctrl+F to start searching in a UI list. The end of the list where the scroll button appears may not be in view. Plus while filtering the number of visible items changes so the scrolling has to be updated to keep the search button visible. Note that I disabled the auto-scrolling for when the text button spawned an additional popup, like for search-box buttons. That is because current code assumes the button to have a fixed position while the popup is open. There is no code to update the popup position together with the button/scrolling. I also think that the logic added here could be used in more places, e.g. for the "ensure file in view" logic the File Browser does.
2021-07-13 17:06:15 +02:00
UI: butstore API to generalize button storage for modal handlers
2014-02-08 09:03:25 +11:00
/* UI_butstore_ helpers */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
struct uiButStore;
struct uiButStoreElem;
UI: butstore API to generalize button storage for modal handlers
2014-02-08 09:03:25 +11:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Create a new button store, the caller must manage and run #UI_butstore_free
*/
UI: butstore API to generalize button storage for modal handlers
2014-02-08 09:03:25 +11:00
uiButStore *UI_butstore_create(uiBlock *block);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* NULL all pointers, don't free since the owner needs to be able to inspect.
*/
UI: butstore API to generalize button storage for modal handlers
2014-02-08 09:03:25 +11:00
void UI_butstore_clear(uiBlock *block);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Map freed buttons from the old block and update pointers.
*/
UI: butstore API to generalize button storage for modal handlers
2014-02-08 09:03:25 +11:00
void UI_butstore_update(uiBlock *block);
void UI_butstore_free(uiBlock *block, uiButStore *bs);
bool UI_butstore_is_valid(uiButStore *bs);
bool UI_butstore_is_registered(uiBlock *block, uiBut *but);
void UI_butstore_register(uiButStore *bs_handle, uiBut **but_p);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Update the pointer for a registered button.
*/
Fix rare crash dragging number-buttons Could happen dragging shape-keys UIList & the lower slider at once.
2014-12-01 23:30:54 +01:00
bool UI_butstore_register_update(uiBlock *block, uiBut *but_dst, const uiBut *but_src);
UI: butstore API to generalize button storage for modal handlers
2014-02-08 09:03:25 +11:00
void UI_butstore_unregister(uiButStore *bs_handle, uiBut **but_p);
Fix T103267: No shortcuts shown in the Pose Assets context menu Support displaying shortcuts for uiListDyn.custom_drag_* & custom_activate_* operators.
2023-01-11 19:14:35 +11:00
/**
* A version of #WM_key_event_operator_string that's limited to UI elements.
*
* This supports showing shortcuts in context-menus (for example),
* for actions that can also be activated using shortcuts while the cursor is over the button.
* Without this those shortcuts aren't discoverable for users.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
const char *UI_key_event_operator_string(const bContext *C,
Fix T103267: No shortcuts shown in the Pose Assets context menu Support displaying shortcuts for uiListDyn.custom_drag_* & custom_activate_* operators.
2023-01-11 19:14:35 +11:00
const char *opname,
IDProperty *properties,
const bool is_strict,
char *result,
Cleanup: use of the term 'len' & 'maxlen' Only use the term len & maxlen when they represent the length & maximum length of a string. Instead of the available bytes to use. Also include the data they're referencing as a suffix, otherwise it's not always clear what the length is in reference to.
2023-05-07 15:22:58 +10:00
const int result_maxncpy);
Fix T103267: No shortcuts shown in the Pose Assets context menu Support displaying shortcuts for uiListDyn.custom_drag_* & custom_activate_* operators.
2023-01-11 19:14:35 +11:00
UI: move tooltip API to public header
2017-12-20 14:50:39 +11:00
/* ui_interface_region_tooltip.c */
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* \param is_label: When true, show a small tip that only shows the name, otherwise show the full
* tooltip.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
ARegion *UI_tooltip_create_from_button(bContext *C, ARegion *butregion, uiBut *but, bool is_label);
ARegion *UI_tooltip_create_from_button_or_extra_icon(
bContext *C, ARegion *butregion, uiBut *but, uiButExtraOpIcon *extra_icon, bool is_label);
ARegion *UI_tooltip_create_from_gizmo(bContext *C, wmGizmo *gz);
void UI_tooltip_free(bContext *C, bScreen *screen, ARegion *region);
struct uiSearchItemTooltipData {
UI: Tooltip for data-block selector menus, showing full name and library info Long data-block names are clipped to fit into data-block selector menus. For linked data-blocks, there's also a hint indicating the source library, which takes further space and may get clipped too. So this commit adds a tooltip to the menu items, which displays the full, unclipped data-block name and the unclipped library name. Plus, the library path is shown too, which is also useful info. Adds helper functions for search menu item tooltips, so these are easier to add to other search menus in future. Part of T84188.
2021-01-26 22:06:45 +01:00
/** A description for the item, e.g. what happens when selecting it. */
char description[UI_MAX_DRAW_STR];
/* The full name of the item, without prefixes or suffixes (e.g. hint with UI_SEP_CHARP). */
const char *name;
/** Additional info about the item (e.g. library name of a linked data-block). */
char hint[UI_MAX_DRAW_STR];
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
};
UI: Tooltip for data-block selector menus, showing full name and library info Long data-block names are clipped to fit into data-block selector menus. For linked data-blocks, there's also a hint indicating the source library, which takes further space and may get clipped too. So this commit adds a tooltip to the menu items, which displays the full, unclipped data-block name and the unclipped library name. Plus, the library path is shown too, which is also useful info. Adds helper functions for search menu item tooltips, so these are easier to add to other search menus in future. Part of T84188.
2021-01-26 22:06:45 +01:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Create a tooltip from search-item tooltip data \a item_tooltip data.
* To be called from a callback set with #UI_but_func_search_set_tooltip().
*
* \param item_rect: Rectangle of the search item in search region space (#ui_searchbox_butrect())
* which is passed to the tooltip callback.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
ARegion *UI_tooltip_create_from_search_item_generic(
bContext *C,
const ARegion *searchbox_region,
const rcti *item_rect,
UI: Tooltip for data-block selector menus, showing full name and library info Long data-block names are clipped to fit into data-block selector menus. For linked data-blocks, there's also a hint indicating the source library, which takes further space and may get clipped too. So this commit adds a tooltip to the menu items, which displays the full, unclipped data-block name and the unclipped library name. Plus, the library path is shown too, which is also useful info. Adds helper functions for search menu item tooltips, so these are easier to add to other search menus in future. Part of T84188.
2021-01-26 22:06:45 +01:00
const uiSearchItemTooltipData *item_tooltip_data);
UI: move tooltip API to public header
2017-12-20 14:50:39 +11:00
/* How long before a tool-tip shows. */
#define UI_TOOLTIP_DELAY 0.5
UI: delay tool label tip display Displaying the labels tip immediately feels too intrusive, make this work more like regular tooltips, displaying more quickly. Tooltips can now uses multiple passes, each pass with it's own delay for the next pass to show.
2018-09-06 14:19:15 +10:00
#define UI_TOOLTIP_DELAY_LABEL 0.2
UI: butstore API to generalize button storage for modal handlers
2014-02-08 09:03:25 +11:00
Fix issues with float precision in numinput, like 'R 123' who would show additional 'noise' digits. Expose float precision helper in UI_interface.h API, so that numinput can use this helper as numbuttons already do. Reviewed By: campbellbarton Differential Revision: https://developer.blender.org/D186
2014-01-08 17:04:10 +01:00
/* Float precision helpers */
UI/floats: Reduce our UI_PRECISION_FLOAT_MAX by one to avoid most rounding issues. The way we use it, UI_PRECISION_FLOAT_MAX is actually + 1 to get total number of digits, and float only has 7 meaningful digits, so that define shall be at 6.
2017-07-21 10:10:36 +02:00
#define UI_PRECISION_FLOAT_MAX 6
Fix T46134: units degrees increment are too small The user interface was ignoring the precision step size for degrees, making all rotation inputs drag by a 100th of a degree. Now use a 10th of a degree instead.
2015-09-17 21:50:40 +10:00
/* For float buttons the 'step' (or a1), is scaled */
#define UI_PRECISION_FLOAT_SCALE 0.01f
Fix issues with float precision in numinput, like 'R 123' who would show additional 'noise' digits. Expose float precision helper in UI_interface.h API, so that numinput can use this helper as numbuttons already do. Reviewed By: campbellbarton Differential Revision: https://developer.blender.org/D186
2014-01-08 17:04:10 +01:00
UI: cleanup UI_fontstyle_string_width, UI_draw_string Both were maked as temp, but used often. Now pass uiFontStyle to both, rename UI_draw_string to UI_fontstyle_draw_simple, since its a variant of UI_fontstyle_draw that skips shadow, align... etc.
2015-01-20 14:25:39 +11:00
/* Typical UI text */
#define UI_FSTYLE_WIDGET (const uiFontStyle *)&(UI_style_get()->widget)
Fix #102687: Use Proper Style for Label Length Estimation When estimating widget sizes, ui_text_icon_width_ex() assumes that all items are using the "widget" text style, which is incorrect for labels. This PR uses widget_label style for uiItemL_ and the label portion of ui_item_with_label. Pull Request: https://projects.blender.org/blender/blender/pulls/111908
2023-09-05 00:58:57 +02:00
#define UI_FSTYLE_WIDGET_LABEL (const uiFontStyle *)&(UI_style_get()->widgetlabel)
UI: cleanup UI_fontstyle_string_width, UI_draw_string Both were maked as temp, but used often. Now pass uiFontStyle to both, rename UI_draw_string to UI_fontstyle_draw_simple, since its a variant of UI_fontstyle_draw that skips shadow, align... etc.
2015-01-20 14:25:39 +11:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Returns the best "UI" precision for given floating value,
* so that e.g. 10.000001 rather gets drawn as '10'...
*/
UI Refactor T41640 Make the UI API more consistent and reduce confusion with some naming. mainly: - API function calls - enum values some internal static functions have been left for now
2014-11-09 21:20:40 +01:00
int UI_calc_float_precision(int prec, double value);
Fix issues with float precision in numinput, like 'R 123' who would show additional 'noise' digits. Expose float precision helper in UI_interface.h API, so that numinput can use this helper as numbuttons already do. Reviewed By: campbellbarton Differential Revision: https://developer.blender.org/D186
2014-01-08 17:04:10 +01:00
UI: Perf: Add batching capability to widgets. Similiar to how we batch Icons together. This is not enabled in this commit.
2018-04-06 14:25:55 +02:00
/* widget batched drawing */
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_widgetbase_draw_cache_begin();
void UI_widgetbase_draw_cache_flush();
void UI_widgetbase_draw_cache_end();
UI: Perf: Add batching capability to widgets. Similiar to how we batch Icons together. This is not enabled in this commit.
2018-04-06 14:25:55 +02:00
Cleanup: move theme reset into it's own operator file
2019-03-02 00:52:00 +11:00
/* Use for resetting the theme. */
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
* Initialize default theme.
*
* \note When you add new colors, created & saved themes need initialized
* use function below, #init_userdef_do_versions.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_theme_init_default();
void UI_style_init_default();
Cleanup: move theme reset into it's own operator file
2019-03-02 00:52:00 +11:00
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_interface_tag_script_reload();
Fix T58683: Reload Scripts breaks toolbar button formatting Add a function which clears internal cached operator pointers, run before reloading scripts.
2019-10-01 01:59:31 +10:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Special drawing for toolbar, mainly workarounds for inflexible icon sizing. */
Cleanup: USE_UI_* prefix for UI defines Otherwise there is no quick way to see where this comes from.
2018-06-06 09:27:23 +02:00
#define USE_UI_TOOLBAR_HACK
UI: workaround for text & icon alignment Blender's icons weren't written to draw different sizes. For now ifdef in a hack to show toolbar icons larger.
2018-04-25 21:01:36 +02:00
Cleanup: use doxygen formatting in UI_interface.h, DNA_screen_types.h Also use doxygen type references & correct some typos.
2023-07-26 15:23:24 +10:00
/** Support click-drag motion which presses the button and closes a popover (like a menu). */
Cleanup: USE_UI_* prefix for UI defines Otherwise there is no quick way to see where this comes from.
2018-06-06 09:27:23 +02:00
#define USE_UI_POPOVER_ONCE
UI: popover-once (click-drag for single actions) Experimental support for using popovers like menus, use this when the user hold the mouse down (previously this did nothing). This means turning frequently accessed menu items into popovers doesn't add more clicks to the existing use case.
2018-05-19 19:16:47 +02:00
UI: Add filtering support to UI views No user visible changes expected. Needed for the asset shelf (#102879). Adds a UI operator triggered on Ctrl+F that will attempt to start filtering for the hovered UI view, typically enabling a filter text button. View items can implement their own filter method, there's no default one. Maybe we should add default or re-usable string filtering method though. Filtering is applied after constructing the view and filtered out (as in, invisible) items are kept in storage, so that their state (selection, active, etc.) is preserved. The filtered state is cached in the item, so this is only done once per redraw.
2023-06-12 11:41:00 +02:00
/**
* Call the #ui::AbstractView::begin_filtering() function of the view to enable filtering.
* Typically used to enable a filter text button. Triggered on Ctrl+F by default.
* \return True when filtering was enabled successfully.
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_view_begin_filtering(const bContext *C, const uiViewHandle *view_handle);
UI: Add filtering support to UI views No user visible changes expected. Needed for the asset shelf (#102879). Adds a UI operator triggered on Ctrl+F that will attempt to start filtering for the hovered UI view, typically enabling a filter text button. View items can implement their own filter method, there's no default one. Maybe we should add default or re-usable string filtering method though. Filtering is applied after constructing the view and filtered out (as in, invisible) items are kept in storage, so that their state (selection, active, etc.) is preserved. The filtered state is cached in the item, so this is only done once per redraw.
2023-06-12 11:41:00 +02:00
UI: Support minimum row count for tree views No user visible changes expected. With this, empty rows will be added to the tree view so that the background box is at least a few lines high (like with UI lists). If the view is used as a drop target, data can be dropped on these empty rows too then. This was requested for the Cycles light linking project.
2023-03-28 12:33:35 +02:00
bool UI_view_item_is_interactive(const uiViewItemHandle *item_handle);
UI: Port view item features to base class, merge view item button types No user visible changes expected. Merges the tree row and grid tile button types, which were mostly doing the same things. The idea is that there is a button type for highlighting, as well as supporting general view item features (e.g. renaming, drag/drop, etc.). So instead there is a view item button type now. Also ports view item features like renaming, custom context menus, drag controllers and drop controllers to `ui::AbstractViewItem` (the new base class for all view items). This should be quite an improvement because: - Merges code that was duplicated over view items. - Mentioned features (renaming, drag & drop, ...) are much easier to implement in new view types now. Most of it comes "for free". - Further features will immediately become availalbe to all views (e.g. selection). - Simplifies APIs, there don't have to be functions for individual view item types anymore. - View item classes are split and thus less overwhelming visually. - View item buttons now share all code (drawing, handling, etc.) - We're soon running out of available button types, this commit merges two into one. I was hoping I could do this in multiple smaller commits, but things were quite intertwined so that would've taken quite some effort.
2022-07-19 16:14:42 +02:00
bool UI_view_item_is_active(const uiViewItemHandle *item_handle);
bool UI_view_item_matches(const uiViewItemHandle *a_handle, const uiViewItemHandle *b_handle);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
UI: Port view item features to base class, merge view item button types No user visible changes expected. Merges the tree row and grid tile button types, which were mostly doing the same things. The idea is that there is a button type for highlighting, as well as supporting general view item features (e.g. renaming, drag/drop, etc.). So instead there is a view item button type now. Also ports view item features like renaming, custom context menus, drag controllers and drop controllers to `ui::AbstractViewItem` (the new base class for all view items). This should be quite an improvement because: - Merges code that was duplicated over view items. - Mentioned features (renaming, drag & drop, ...) are much easier to implement in new view types now. Most of it comes "for free". - Further features will immediately become availalbe to all views (e.g. selection). - Simplifies APIs, there don't have to be functions for individual view item types anymore. - View item classes are split and thus less overwhelming visually. - View item buttons now share all code (drawing, handling, etc.) - We're soon running out of available button types, this commit merges two into one. I was hoping I could do this in multiple smaller commits, but things were quite intertwined so that would've taken quite some effort.
2022-07-19 16:14:42 +02:00
* Can \a item_handle be renamed right now? Note that this isn't just a mere wrapper around
* #AbstractViewItem::supports_renaming(). This also checks if there is another item being renamed,
* and returns false if so.
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
UI: Port view item features to base class, merge view item button types No user visible changes expected. Merges the tree row and grid tile button types, which were mostly doing the same things. The idea is that there is a button type for highlighting, as well as supporting general view item features (e.g. renaming, drag/drop, etc.). So instead there is a view item button type now. Also ports view item features like renaming, custom context menus, drag controllers and drop controllers to `ui::AbstractViewItem` (the new base class for all view items). This should be quite an improvement because: - Merges code that was duplicated over view items. - Mentioned features (renaming, drag & drop, ...) are much easier to implement in new view types now. Most of it comes "for free". - Further features will immediately become availalbe to all views (e.g. selection). - Simplifies APIs, there don't have to be functions for individual view item types anymore. - View item classes are split and thus less overwhelming visually. - View item buttons now share all code (drawing, handling, etc.) - We're soon running out of available button types, this commit merges two into one. I was hoping I could do this in multiple smaller commits, but things were quite intertwined so that would've taken quite some effort.
2022-07-19 16:14:42 +02:00
bool UI_view_item_can_rename(const uiViewItemHandle *item_handle);
void UI_view_item_begin_rename(uiViewItemHandle *item_handle);
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
void UI_view_item_context_menu_build(bContext *C,
UI: Port view item features to base class, merge view item button types No user visible changes expected. Merges the tree row and grid tile button types, which were mostly doing the same things. The idea is that there is a button type for highlighting, as well as supporting general view item features (e.g. renaming, drag/drop, etc.). So instead there is a view item button type now. Also ports view item features like renaming, custom context menus, drag controllers and drop controllers to `ui::AbstractViewItem` (the new base class for all view items). This should be quite an improvement because: - Merges code that was duplicated over view items. - Mentioned features (renaming, drag & drop, ...) are much easier to implement in new view types now. Most of it comes "for free". - Further features will immediately become availalbe to all views (e.g. selection). - Simplifies APIs, there don't have to be functions for individual view item types anymore. - View item classes are split and thus less overwhelming visually. - View item buttons now share all code (drawing, handling, etc.) - We're soon running out of available button types, this commit merges two into one. I was hoping I could do this in multiple smaller commits, but things were quite intertwined so that would've taken quite some effort.
2022-07-19 16:14:42 +02:00
const uiViewItemHandle *item_handle,
uiLayout *column);
UI: Asset Shelf Support (Experimental Feature) No user visible changes expected, except of new experimental feature option. ------------------------------------------------------------------------------ This introduces asset shelves as a new standard UI element for accessing assets. Based on the current context (like the active mode and/or tool), they can provide assets for specific workflows/tasks. As such they are more limited in functionality than the asset browser, but a lot more efficient for certain tasks. The asset shelf is developed as part of the brush assets project (see #101895), but is also meant to replace the current pose library UI. Support for asset shelves can quite easily be added to different editor types, the following commit will add support for the 3D View. If an editor type supports asset shelves, add-ons can chose to register an asset shelf type for an editor with just a few lines of Python. It should be possible to entirely remove `UILayout.asset_view_template()` once asset shelves are non-experimental. Some changes are to be expected still, see #107881. Task: #102879 Brush asset workflow blog post: https://code.blender.org/2022/12/brush-assets-workflow/ Initial technical documentation: https://developer.blender.org/docs/asset_system/user_interface/asset_shelf/ Pull Request: #104831
2023-08-03 16:54:39 +02:00
bool UI_view_item_supports_drag(const uiViewItemHandle *item_);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
UI: Port view item features to base class, merge view item button types No user visible changes expected. Merges the tree row and grid tile button types, which were mostly doing the same things. The idea is that there is a button type for highlighting, as well as supporting general view item features (e.g. renaming, drag/drop, etc.). So instead there is a view item button type now. Also ports view item features like renaming, custom context menus, drag controllers and drop controllers to `ui::AbstractViewItem` (the new base class for all view items). This should be quite an improvement because: - Merges code that was duplicated over view items. - Mentioned features (renaming, drag & drop, ...) are much easier to implement in new view types now. Most of it comes "for free". - Further features will immediately become availalbe to all views (e.g. selection). - Simplifies APIs, there don't have to be functions for individual view item types anymore. - View item classes are split and thus less overwhelming visually. - View item buttons now share all code (drawing, handling, etc.) - We're soon running out of available button types, this commit merges two into one. I was hoping I could do this in multiple smaller commits, but things were quite intertwined so that would've taken quite some effort.
2022-07-19 16:14:42 +02:00
* Attempt to start dragging \a item_. This will not work if the view item doesn't
* support dragging, i.e. if it won't create a drag-controller upon request.
* \return True if dragging started successfully, otherwise false.
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
bool UI_view_item_drag_start(bContext *C, const uiViewItemHandle *item_);
UI: Generalize drop target API, support drop targets for UI views Previously UI view items would support custom drop controllers (so they could react to data being dragged over them and dropped). This is now more generalized so the views themselves can do this as well. Main changes: - Support calculating a bounding box for the view, so this can be used for recognizing mouse hovering. - Rename "drop controller" to "drop target", this is more clear, less abstract naming. - Generalize drop controllers/targets. There is a new `ui::DropTargetInterface` now. - Add support for drop targets in the `ui::AbstractView` base class, so custom views can use this. Pull Request: https://projects.blender.org/blender/blender/pulls/105963
2023-03-22 18:45:35 +01:00
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
UI: Generalize drop target API, support drop targets for UI views Previously UI view items would support custom drop controllers (so they could react to data being dragged over them and dropped). This is now more generalized so the views themselves can do this as well. Main changes: - Support calculating a bounding box for the view, so this can be used for recognizing mouse hovering. - Rename "drop controller" to "drop target", this is more clear, less abstract naming. - Generalize drop controllers/targets. There is a new `ui::DropTargetInterface` now. - Add support for drop targets in the `ui::AbstractView` base class, so custom views can use this. Pull Request: https://projects.blender.org/blender/blender/pulls/105963
2023-03-22 18:45:35 +01:00
* \param xy: Coordinate to find a view item at, in window space.
* \param pad: Extra padding added to the bounding box of the view.
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiViewHandle *UI_region_view_find_at(const ARegion *region, const int xy[2], int pad);
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
/**
UI: Port view item features to base class, merge view item button types No user visible changes expected. Merges the tree row and grid tile button types, which were mostly doing the same things. The idea is that there is a button type for highlighting, as well as supporting general view item features (e.g. renaming, drag/drop, etc.). So instead there is a view item button type now. Also ports view item features like renaming, custom context menus, drag controllers and drop controllers to `ui::AbstractViewItem` (the new base class for all view items). This should be quite an improvement because: - Merges code that was duplicated over view items. - Mentioned features (renaming, drag & drop, ...) are much easier to implement in new view types now. Most of it comes "for free". - Further features will immediately become availalbe to all views (e.g. selection). - Simplifies APIs, there don't have to be functions for individual view item types anymore. - View item classes are split and thus less overwhelming visually. - View item buttons now share all code (drawing, handling, etc.) - We're soon running out of available button types, this commit merges two into one. I was hoping I could do this in multiple smaller commits, but things were quite intertwined so that would've taken quite some effort.
2022-07-19 16:14:42 +02:00
* \param xy: Coordinate to find a view item at, in window space.
Cleanup: move public doc-strings into headers for 'editors' Ref T92709
2021-12-09 00:55:11 +11:00
*/
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiViewItemHandle *UI_region_views_find_item_at(const ARegion *region, const int xy[2])
UI: Port view item features to base class, merge view item button types No user visible changes expected. Merges the tree row and grid tile button types, which were mostly doing the same things. The idea is that there is a button type for highlighting, as well as supporting general view item features (e.g. renaming, drag/drop, etc.). So instead there is a view item button type now. Also ports view item features like renaming, custom context menus, drag controllers and drop controllers to `ui::AbstractViewItem` (the new base class for all view items). This should be quite an improvement because: - Merges code that was duplicated over view items. - Mentioned features (renaming, drag & drop, ...) are much easier to implement in new view types now. Most of it comes "for free". - Further features will immediately become availalbe to all views (e.g. selection). - Simplifies APIs, there don't have to be functions for individual view item types anymore. - View item classes are split and thus less overwhelming visually. - View item buttons now share all code (drawing, handling, etc.) - We're soon running out of available button types, this commit merges two into one. I was hoping I could do this in multiple smaller commits, but things were quite intertwined so that would've taken quite some effort.
2022-07-19 16:14:42 +02:00
ATTR_NONNULL();
Cleanup: Remove unnecessary struct keyword from editors includes
2023-08-04 22:15:25 -04:00
uiViewItemHandle *UI_region_views_find_active_item(const ARegion *region);
uiBut *UI_region_views_find_active_item_but(const ARegion *region);
Reference in New Issue Copy Permalink