foobar2000 SDK  2015-08-03
Public Member Functions
ui_element_children_enumeratorabstract

#include <ui_element.h>

+ Inheritance diagram for ui_element_children_enumerator:

Public Member Functions

virtual bool can_set_count ()=0
 
virtual ui_element_config::ptr commit ()=0
 
 FB2K_MAKE_SERVICE_INTERFACE (ui_element_children_enumerator, service_base)
 
virtual t_size get_count ()=0
 
virtual ui_element_config::ptr get_item (t_size p_index)=0
 
virtual void set_count (t_size count)=0
 
virtual void set_item (t_size p_index, ui_element_config::ptr cfg)=0
 
- 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 ()
 

Additional Inherited Members

- Public Types inherited from service_base
typedef service_base t_interface
 
- Protected Member Functions inherited from service_base
 service_base ()
 
 ~service_base ()
 

Detailed Description

Interface to enumerate and possibly alter children of a container element. Obtained from ui_element::enumerate_children().

Definition at line 343 of file ui_element.h.

Member Function Documentation

virtual bool ui_element_children_enumerator::can_set_count ( )
pure virtual

Returns whether children count can be altered. For certain containers, children count is fixed and this method returns false.

virtual ui_element_config::ptr ui_element_children_enumerator::commit ( )
pure virtual

Creates a new ui_element_config for this container, with our changes (set_count(), set_item()) applied.

ui_element_children_enumerator::FB2K_MAKE_SERVICE_INTERFACE ( ui_element_children_enumerator  ,
service_base   
)
virtual t_size ui_element_children_enumerator::get_count ( )
pure virtual

Retrieves the container's children count.

virtual ui_element_config::ptr ui_element_children_enumerator::get_item ( t_size  p_index)
pure virtual

Retrieves the configuration of the child at specified index, 0 <= index < get_count().

virtual void ui_element_children_enumerator::set_count ( t_size  count)
pure virtual

Alters container's children count (behavior is undefined when can_set_count() returns false). Newly allocated children get default empty element configuration.

virtual void ui_element_children_enumerator::set_item ( t_size  p_index,
ui_element_config::ptr  cfg 
)
pure virtual

Alters the selected item.


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