Mercurial > foo_out_sdl
diff foosdk/sdk/foobar2000/SDK/ui_edit_context.h @ 1:20d02a178406 default tip
*: check in everything else
yay
| author | Paper <paper@tflc.us> |
|---|---|
| date | Mon, 05 Jan 2026 02:15:46 -0500 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/foosdk/sdk/foobar2000/SDK/ui_edit_context.h Mon Jan 05 02:15:46 2026 -0500 @@ -0,0 +1,109 @@ +#pragma once + +//! A class used to redirect actions coming from the 'edit' menu, typically provided by the UI Element having focus. \n +//! Use ui_edit_context_manager to register and manipulate. +class NOVTABLE ui_edit_context : public service_base { + FB2K_MAKE_SERVICE_INTERFACE(ui_edit_context, service_base) +public: + //! Called by core only. + virtual void initialize() = 0; + //! Called by core only. \n + //! WARNING: you may get other methods called after shutdown() in case someone using ui_edit_context_manager has kept a reference to your service - for an example during an async operation. You should behave sanely in such case - either execute the operation if still possible or fail cleanly. + virtual void shutdown() = 0; + + enum { + flag_removable = 1, + flag_reorderable = 2, + flag_undoable = 4, + flag_redoable = 8, + flag_linearlist = 16, + flag_searchable = 32, + flag_insertable = 64, + }; + + virtual t_uint32 get_flags() = 0; + + bool can_remove() {return (get_flags() & flag_removable) != 0;} + bool test_flags(t_uint32 flags) {return (get_flags() & flags) == flags;} + bool can_remove_mask() {return test_flags(flag_removable | flag_linearlist);} + bool can_reorder() {return test_flags(flag_reorderable);} + bool can_search() {return test_flags(flag_searchable);} + + virtual void select_all(); + virtual void select_none(); + virtual void get_selected_items(metadb_handle_list_ref out); + virtual void remove_selection(); + virtual void crop_selection(); + virtual void clear(); + virtual void get_all_items(metadb_handle_list_ref out); + virtual GUID get_selection_type() = 0; + + // available if flag_linearlist is set + virtual void get_selection_mask(pfc::bit_array_var & out); + + virtual void update_selection(const pfc::bit_array & mask, const pfc::bit_array & newVals) = 0; + virtual t_size get_item_count(t_size max = ~0) = 0; + virtual metadb_handle_ptr get_item(t_size index) = 0; + virtual void get_items(metadb_handle_list_ref out, pfc::bit_array const & mask) = 0; + virtual bool is_item_selected(t_size item) = 0; + virtual void remove_items(pfc::bit_array const & mask) = 0; + virtual void reorder_items(const t_size * order, t_size count) = 0; + virtual t_size get_selection_count(t_size max = ~0); + + virtual void search() = 0; + + virtual void undo_backup() = 0; + virtual void undo_restore() = 0; + virtual void redo_restore() = 0; + + virtual void insert_items(t_size at, metadb_handle_list_cref items, pfc::bit_array const & selection) = 0; + + virtual t_size query_insert_mark() = 0; + + void sort_by_format(const char * spec, bool onlySelection); + + //! Safely prevent destruction from worker threads (some components attempt that). + static bool serviceRequiresMainThreadDestructor() { return true; } +}; + +//! Special case of ui_edit_context operating on a specific playlist (see playlist_manager). \n +//! Use this to let everyone know that your methods operate on a playlist, \n +//! in case some component wishes to provide additional functionality based on that. +class ui_edit_context_playlist : public ui_edit_context { + FB2K_MAKE_SERVICE_INTERFACE(ui_edit_context_playlist, ui_edit_context) +public: + virtual t_size get_playlist_number() = 0; +}; + +//! Entrypoint class for registering and manipulating ui_edit_context objects. \n +//! Implemented by core. +class NOVTABLE ui_edit_context_manager : public service_base { + FB2K_MAKE_SERVICE_COREAPI(ui_edit_context_manager) +public: + //! Sets the current edit context. \n + //! Typically called when a part of your UI receives focus. \n + //! @returns An identifier than can later be passed to unset_context when focus is lost. + virtual t_uint32 set_context(ui_edit_context::ptr context) = 0; + //! Removes an edit context. \n + //! @param id The value returned by matching set_context() call. + virtual void unset_context(t_uint32 id) = 0; + //! Retrieves the current context object. May return null when there's no context. + //! @returns The currently active context object, possibly null if none. + virtual ui_edit_context::ptr get_context() = 0; + //! Creates a context wrapping a specific playlist; see also playlist_manager. + //! @param playlist_number Number of wrapped playlist, per playlist_manager numbering. + //! @returns Newly creted context object. + virtual ui_edit_context::ptr create_playlist_context(t_size playlist_number) = 0; + //! By default, when no context is registered, \n + //! for an example, if the active user interface component is not ui_edit_context-aware, \n + //! a fallback context is automatically set; it follows the active playlist,\n + //! so the edit menu does something meaningful. \n + //! This method is intended to be called during initialiation of an user interface component; \n + //! it tells foobar2000 core to suppress the active playlist fallback-\n + //! but then entire edit menu becomes non-functional if no context is provided. + virtual void disable_autofallback() = 0; + //! Helper, sets the current context to an implemented-by-core context that tracks the active playlist. \n + //! Typically called when a part of your UI receives focus. + //! @returns Identifier value to pass to unset_context() when your focus is gone. + virtual t_uint32 set_context_active_playlist() = 0; +};
