ui_edit_context

#include <ui_edit_context.h>

Inheritance diagram for ui_edit_context:

Private Types
enum	{   flag_removable = 1, flag_reorderable = 2, flag_undoable = 4, flag_redoable = 8,   flag_linearlist = 16, flag_searchable = 32, flag_insertable = 64 }

Private Member Functions
bool	can_remove ()
bool	can_remove_mask ()
bool	can_reorder ()
bool	can_search ()
virtual void	clear ()
virtual void	crop_selection ()
virtual void	get_all_items (metadb_handle_list_ref out)
virtual t_uint32	get_flags ()=0
virtual metadb_handle_ptr	get_item (t_size index)=0
virtual t_size	get_item_count (t_size max=~0)=0
virtual void	get_items (metadb_handle_list_ref out, pfc::bit_array const &mask)=0
virtual void	get_selected_items (metadb_handle_list_ref out)
virtual t_size	get_selection_count (t_size max=~0)
virtual void	get_selection_mask (pfc::bit_array_var &out)
virtual GUID	get_selection_type ()=0
virtual void	insert_items (t_size at, metadb_handle_list_cref items, pfc::bit_array const &selection)=0
virtual bool	is_item_selected (t_size item)=0
virtual t_size	query_insert_mark ()=0
virtual void	redo_restore ()=0
virtual void	remove_items (pfc::bit_array const &mask)=0
virtual void	remove_selection ()
virtual void	reorder_items (const t_size *order, t_size count)=0
virtual void	search ()=0
virtual void	select_all ()
virtual void	select_none ()
virtual FB2K_MAKE_SERVICE_INTERFACE(ui_edit_context, service_base) public void	shutdown ()=0
void	sort_by_format (const char *spec, bool onlySelection)
bool	test_flags (t_uint32 flags)
virtual void	undo_backup ()=0
virtual void	undo_restore ()=0
virtual void	update_selection (const pfc::bit_array &mask, const pfc::bit_array &newVals)=0

Additional Inherited Members
Public Types inherited from service_base
typedef service_base	t_interface
Public Member Functions inherited from service_base
template<typename outPtr_t >
bool	cast (outPtr_t &outPtr)
virtual int	service_add_ref ()=0 throw ()
virtual bool	service_query (service_ptr_t< service_base > &p_out, const GUID &p_guid)
template<class T >
bool	service_query_t (service_ptr_t< T > &p_out)
virtual int	service_release ()=0 throw ()
Protected Member Functions inherited from service_base
	service_base ()
	~service_base ()

Detailed Description

Definition at line 2 of file ui_edit_context.h.

Member Enumeration Documentation

anonymous enum

private

Enumerator
flag_removable
flag_reorderable
flag_undoable
flag_redoable
flag_linearlist
flag_searchable
flag_insertable

Definition at line 11 of file ui_edit_context.h.

         {
        flag_removable = 1,
        flag_reorderable = 2,
        flag_undoable = 4,
        flag_redoable = 8,
        flag_linearlist = 16,
        flag_searchable = 32,
        flag_insertable = 64,
    };

Member Function Documentation

bool ui_edit_context::can_remove ( )

inlineprivate

Definition at line 23 of file ui_edit_context.h.

{return (get_flags() & flag_removable) != 0;}

bool ui_edit_context::can_remove_mask ( )

inlineprivate

Definition at line 25 of file ui_edit_context.h.

{return test_flags(flag_removable | flag_linearlist);}

bool ui_edit_context::can_reorder ( )

inlineprivate

Definition at line 26 of file ui_edit_context.h.

{return test_flags(flag_reorderable);}

bool ui_edit_context::can_search ( )

inlineprivate

Definition at line 27 of file ui_edit_context.h.

{return test_flags(flag_searchable);}

virtual void ui_edit_context::clear ( )

inlineprivatevirtual

Definition at line 34 of file ui_edit_context.h.

{remove_items(bit_array_true());}

virtual void ui_edit_context::crop_selection ( )

inlineprivatevirtual

Definition at line 33 of file ui_edit_context.h.

{bit_array_bittable mask(get_item_count()); get_selection_mask(mask); remove_items(bit_array_not(mask));}

virtual void ui_edit_context::get_all_items ( metadb_handle_list_ref  out )

inlineprivatevirtual

Definition at line 35 of file ui_edit_context.h.

{get_items(out, bit_array_true());}

virtual t_uint32 ui_edit_context::get_flags ( )

privatepure virtual

virtual metadb_handle_ptr ui_edit_context::get_item ( t_size  index )

privatepure virtual

virtual t_size ui_edit_context::get_item_count ( t_size  max = ~0 )

privatepure virtual

virtual void ui_edit_context::get_items ( metadb_handle_list_ref  out, pfc::bit_array const &  mask  )

privatepure virtual

virtual void ui_edit_context::get_selected_items ( metadb_handle_list_ref  out )

inlineprivatevirtual

Definition at line 31 of file ui_edit_context.h.

{bit_array_bittable mask(get_item_count()); get_selection_mask(mask); get_items(out, mask);}

virtual t_size ui_edit_context::get_selection_count ( t_size  max = ~0 )

inlineprivatevirtual

Definition at line 49 of file ui_edit_context.h.

                                                        {
        t_size count = 0;
        const t_size total = get_item_count();
        for(t_size walk = 0; walk < total && count < max; ++walk) if (is_item_selected(walk)) ++count;
        return count;
    }

virtual void ui_edit_context::get_selection_mask ( pfc::bit_array_var &  out )

inlineprivatevirtual

Definition at line 39 of file ui_edit_context.h.

                                                            {
        const t_size count = get_item_count(); for(t_size walk = 0; walk < count; ++walk) out.set(walk, is_item_selected(walk));
    }

virtual GUID ui_edit_context::get_selection_type ( )

privatepure virtual

virtual void ui_edit_context::insert_items ( t_size  at, metadb_handle_list_cref  items, pfc::bit_array const &  selection  )

privatepure virtual

virtual bool ui_edit_context::is_item_selected ( t_size  item )

privatepure virtual

virtual t_size ui_edit_context::query_insert_mark ( )

privatepure virtual

virtual void ui_edit_context::redo_restore ( )

privatepure virtual

virtual void ui_edit_context::remove_items ( pfc::bit_array const &  mask )

privatepure virtual

virtual void ui_edit_context::remove_selection ( )

inlineprivatevirtual

Definition at line 32 of file ui_edit_context.h.

{bit_array_bittable mask(get_item_count()); get_selection_mask(mask); remove_items(mask);}

virtual void ui_edit_context::reorder_items ( const t_size *  order, t_size  count  )

privatepure virtual

virtual void ui_edit_context::search ( )

privatepure virtual

virtual void ui_edit_context::select_all ( )

inlineprivatevirtual

Definition at line 29 of file ui_edit_context.h.

{update_selection(bit_array_true(), bit_array_true());}

virtual void ui_edit_context::select_none ( )

inlineprivatevirtual

Definition at line 30 of file ui_edit_context.h.

{update_selection(bit_array_true(), bit_array_false());}

virtual FB2K_MAKE_SERVICE_INTERFACE (ui_edit_context, service_base) public void ui_edit_context::shutdown ( )

privatepure virtual

Called by core only.
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.

void ui_edit_context::sort_by_format ( const char *  spec, bool  onlySelection  )

inlineprivate

Definition at line 66 of file ui_edit_context.h.

                                                               {
        const t_size count = get_item_count();
        pfc::array_t<t_size> order; order.set_size(count);
        pfc::array_t<t_size> sel_map;
        if (onlySelection) {
            sel_map.set_size(count);
            t_size sel_count = 0;
            for(t_size n=0;n<count;n++) if (is_item_selected(n)) sel_map[sel_count++]=n;
            sel_map.set_size(sel_count);
        }

        {
            metadb_handle_list temp;
            pfc::array_t<t_size> order_temp;
            if (onlySelection) {
                get_selected_items(temp);
                order_temp.set_size(count);
            } else {
                get_all_items(temp);
            }

            
            if (spec != NULL) {
                temp.sort_by_format_get_order(onlySelection ? order_temp.get_ptr() : order.get_ptr(),spec,0);
            } else {
                static_api_ptr_t<genrand_service> api; api->seed((unsigned)__rdtsc());
                api->generate_random_order(onlySelection ? order_temp.get_ptr() : order.get_ptr(),temp.get_count());
            }

            if (onlySelection) {
                t_size n,ptr;
                for(n=0,ptr=0;n<count;n++) {
                    if (!is_item_selected(n)) {
                        order[n] = n;
                    } else {
                        t_size v = order_temp[ptr++];
                        order[n] = sel_map[v];
                    }
                }
            }
        }

        reorder_items(order.get_ptr(), count);
    }

bool ui_edit_context::test_flags ( t_uint32  flags )

inlineprivate

Definition at line 24 of file ui_edit_context.h.

{return (get_flags() & flags) == flags;}

virtual void ui_edit_context::undo_backup ( )

privatepure virtual

virtual void ui_edit_context::undo_restore ( )

privatepure virtual

virtual void ui_edit_context::update_selection ( const pfc::bit_array &  mask, const pfc::bit_array &  newVals  )

privatepure virtual

---

The documentation for this class was generated from the following file:

• foobar2000/SDK/ui_edit_context.h