xtd::forms::control::control_collection Class Reference

#include <control.h>

Definition

Represents a collection of controls.

Inherits xtd::forms::layout::arranged_element_collection< control_ref >.

Public Types
using	base = xtd::forms::layout::arranged_element_collection< control_ref >
	Represents the base type of the collection.
Public Types inherited from xtd::forms::layout::arranged_element_collection< control_ref >
using	allocator_type = std::allocator< value_type >
	Represents the allocator type of the collection.
using	const_iterator = typename std::vector< value_type >::const_iterator
	Represents the const iterator type of the collection.
using	const_pointer = typename std::allocator_traits< allocator_type >::const_pointer
	Represents the value type const pointer of the collection.
using	const_reference = const value_type &
	Represents the value type const reference the collection.
using	const_reverse_iterator = typename std::vector< value_type >::const_reverse_iterator
	Represents the const reverse iterator type of the collection.
using	difference_type = std::ptrdiff_t
	Represents the pointer difference type of the collection.
using	iterator = typename std::vector< value_type >::iterator
	Represents the iterator type of the collection.
using	pointer = typename std::allocator_traits< allocator_type >::pointer
	Represents the value type pointer of the collection.
using	reference = value_type &
	Represents the value type reference of the collection.
using	reverse_iterator = typename std::vector< value_type >::reverse_iterator
	Represents the reverse iterator type of the collection.
using	size_type = std::size_t
	Represents the size type of the collection.

Public Member Functions
	control_collection (const allocator_type &allocator=allocator_type())
	Creates a new object xtd::forms::control::control_collection with specified allocator (optional).
std::optional< value_type >	operator[] (const xtd::ustring &name)
	Gets the first xtd::forms::control::control_collection in the list with the specified name.
std::optional< value_type >	operator[] (const xtd::ustring &name) const
	Gets the first xtd::forms::control::control_collection in the list with the specified name.
Public Member Functions inherited from xtd::forms::layout::arranged_element_collection< control_ref >
	arranged_element_collection (const allocator_type &allocator=allocator_type())
	Creates a new object xtd::forms::layout::arranged_element_collection with specified allocator (optional).
	arranged_element_collection (const std::initializer_list< control_ref > &il)
	Creates a new object xtd::diagnostics::trace_listener_collection with specified initializer list.
reference	at (size_type pos)
	Access specified element with bounds checking.
const_reference	at (size_type pos) const
	Access specified element with bounds checking.
reference	back ()
	Access the last element.
const_reference	back () const
	Access the last element.
iterator	begin ()
	Returns an iterator to the beginning.
const_iterator	begin () const
	Returns an iterator to the beginning.
size_type	capacity () const
	Returns the number of elements that can be held in currently allocated storage.
const_iterator	cbegin () const
	Returns an iterator to the beginning.
const_iterator	cend () const
	Returns an iterator to the end.
void	clear ()
	clears the contents.
const_reverse_iterator	crbegin () const
	Returns a reverse iterator to the end.
const_reverse_iterator	crend () const
	Returns a reverse iterator to the end.
pointer	data ()
	Direct access to the underlying array.
const_pointer	data () const
	Direct access to the underlying array.
bool	empty () const
	Checks whether the container is empty.
iterator	end ()
	Returns an iterator to the end.
const_iterator	end () const
	Returns an iterator to the end.
iterator	erase (const_iterator first, const_iterator last)
	Erases elements at specified range.
iterator	erase (const_iterator pos)
	Erases element at specified position.
iterator	erase (iterator first, iterator last)
	Erases elements at specified range.
iterator	erase (iterator pos)
	Erases element at specified position.
void	erase_at (size_t index)
	Erases element at specified index.
reference	front ()
	Access the first element.
const_reference	front () const
	Access the first element.
allocator_type	get_allocator () const
	Returns the associated allocator.
iterator	insert (const_iterator pos, const value_type &&value)
	Inserts specified element at specified position.
iterator	insert (const_iterator pos, const value_type &value)
	Inserts specified element at specified position.
iterator	insert (iterator pos, const value_type &value)
	Inserts specified element at specified position.
void	insert_at (size_t index, const value_type &value)
	Inserts specified element at specified index.
size_type	max_size () const
	Returns the maximum possible number of elements.
reference	operator[] (size_type pos)
	Access specified element.
const_reference	operator[] (size_type pos) const
	Access specified element.
void	push_back (const value_type &item)
	Adds an element to the end.
void	push_back (value_type &&item)
	Adds an element to the end.
void	push_back_range (collection_t collection)
	Adds elements to the end.
void	push_back_range (const arranged_element_collection &collection)
	Adds elements to the end.
void	push_back_range (const std::initializer_list< value_type > &collection)
	Adds elements to the end.
void	push_back_range (const std::vector< value_type > &collection)
	Adds elements to the end.
reverse_iterator	rbegin ()
	Returns a reverse iterator to the end.
const_reverse_iterator	rbegin () const
	Returns a reverse iterator to the end.
reverse_iterator	rend ()
	Returns a reverse iterator to the end.
const_reverse_iterator	rend () const
	Returns a reverse iterator to the end.
void	reserve (size_type size)
	Reserves storage.
void	shrink_to_fit ()
	Reduces memory usage by freeing unused memory.
size_type	size () const
	Returns the number of elements.
void	sort ()
	Sorts the content.
bool	sorted () const
	Checks whether the container is sorted.
void	sorted (bool value)
	Sets the container is sorted.
std::vector< control_ref >	to_array () const
	Gets an array with the elements of the container.
std::vector< control_ref >	to_vector () const
	Gets an array with the elements of the container.

Additional Inherited Members
Public Attributes inherited from xtd::forms::layout::arranged_element_collection< control_ref >
event< arranged_element_collection, delegate< void(size_t, control_ref &item)> >	item_added
	Occurs when an item is added to the collection.
event< arranged_element_collection, delegate< void(size_t, control_ref &item)> >	item_erased
	Occurs when an item is erased from the collection.
event< arranged_element_collection, delegate< void(size_t, control_ref &item)> >	item_updated
	Occurs when an item is updated in the collection.
Static Public Attributes inherited from xtd::forms::layout::arranged_element_collection< control_ref >
static const size_type	npos
	This is a special value equal to the maximum value representable by the type size_t.

Member Typedef Documentation

base

using xtd::forms::control::control_collection::base = xtd::forms::layout::arranged_element_collection<control_ref>

Represents the base type of the collection.

Constructor & Destructor Documentation

control_collection()

xtd::forms::control::control_collection::control_collection ( const allocator_type &  allocator = allocator_type() )

explicit

Creates a new object xtd::forms::control::control_collection with specified allocator (optional).

Parameters

allocator

The allocator associate to the collection (optional).

Remarks

If allocator not specified, the std::allocator<value_type> is used.

Member Function Documentation

operator[]() [1/2]

std::optional< value_type > xtd::forms::control::control_collection::operator[]

(

const xtd::ustring &

name

)

Gets the first xtd::forms::control::control_collection in the list with the specified name.

Parameters

name	The name of the xtd::forms::control to get from the list.

Returns

The first xtd::forms::control in the list with the given Name. This item returns optional with no value if no xtd::forms::control with the given name can be found.

Remarks

The operator[] property is case-sensitive when searching for names. That is, if two controls exist with the names "Lname" and "lname", operator[] property will find only the xtd::forms::control with the xtd::forms::control::name() that you specify, not both.

operator[]() [2/2]

std::optional< value_type > xtd::forms::control::control_collection::operator[]

(

const xtd::ustring &

name

)

const

Gets the first xtd::forms::control::control_collection in the list with the specified name.

Parameters

name	The name of the xtd::forms::control to get from the list.

Returns

The first xtd::forms::control in the list with the given Name. This item returns optional with no value if no xtd::forms::control with the given name can be found.

Remarks

The operator[] property is case-sensitive when searching for names. That is, if two controls exist with the names "Lname" and "lname", operator[] property will find only the xtd::forms::control with the xtd::forms::control::name() that you specify, not both.

---

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

• xtd.forms/include/xtd/forms/control.h