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

Inheritance diagram for xtd::forms::control::control_collection:

Definition

Represents a collection of controls.

Public Aliases
using	base
	Represents the base type of the collection.

Public Constructors
	control_collection (const allocator_type &allocator=allocator_type())
	Creates a new object xtd::forms::control::control_collection with specified allocator (optional).
	control_collection (bool keep_cloned_controls, const allocator_type &allocator=allocator_type())
	Creates a new object xtd::forms::control::control_collection with specified keep_cloned_controls, and allocator (optional).

Operators
std::optional< value_type >	operator[] (const xtd::string &name) const
	Gets the first xtd::forms::control::control_collection in the list with the specified name.
std::optional< value_type >	operator[] (const xtd::string &name)
	Gets the first xtd::forms::control::control_collection in the list with the specified name.

Public Methods
template<class control_t, class ... args_t>
control_t &	emplace (const_iterator pos, args_t &&...args)
	Creates and inserts specified control at specified position.
template<class control_t, class ... args_t>
control_t &	emplace_at (size_t index, args_t &&...args)
	Creates and inserts specified control at specified position.
template<class control_t, class ... args_t>
control_t &	emplace_back (args_t &&...args)
	Creates and adds a control to the end.
iterator	insert (const_iterator pos, const value_type &value) override
	Inserts specified element at specified position.
void	insert_at (size_t index, const value_type &value) override
	Inserts specified element at specified index.
void	push_back (const value_type &value) override
	Adds an element to the end.
template<class control_t>
iterator	insert (const_iterator pos, control_t &value)
template<class control_t>
void	insert_at (size_t index, control_t &value)
template<class control_t>
void	push_back (control_t &value)

Protected Methods
void	on_item_removed (size_t index, control_ref &item) override
	Raises the xtd::forms::layout::arranged_element_collection::item_removed event.

Additional Inherited Members
using	allocator_type
	Represents the allocator type of the collection.
using	size_type
	Represents the size type of the collection.
using	difference_type
	Represents the pointer difference type of the collection.
using	reference
	Represents the value type reference of the collection.
using	const_reference
	Represents the value type const reference the collection.
using	pointer
	Represents the value type pointer of the collection.
using	const_pointer
	Represents the value type const pointer of the collection.
using	iterator
	Represents the iterator type of the collection.
using	const_iterator
	Represents the const iterator type of the collection.
using	reverse_iterator
	Represents the reverse iterator type of the collection.
using	const_reverse_iterator
	Represents the const reverse iterator type of the collection.
using	allocator_type
	Represents the allocator type of the collection.
using	size_type
	Represents the size type of the collection.
using	difference_type
	Represents the pointer difference type of the collection.
using	reference
	Represents the value type reference of the collection.
using	const_reference
	Represents the value type const reference the collection.
using	pointer
	Represents the value type pointer of the collection.
using	const_pointer
	Represents the value type const pointer of the collection.
using	iterator
	Represents the iterator type of the collection.
using	const_iterator
	Represents the const iterator type of the collection.
using	reverse_iterator
	Represents the reverse iterator type of the collection.
using	const_reverse_iterator
	Represents the const reverse iterator type of the collection.
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_updated
	Occurs when an item is updated in the collection.
event< arranged_element_collection, delegate< void(size_t, control_ref &item)> >	item_removed
	Occurs when an item is removed from the collection.
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_updated
	Occurs when an item is updated in the collection.
event< arranged_element_collection, delegate< void(size_t, control_ref &item)> >	item_removed
	Occurs when an item is removed from the collection.
static constexpr xtd::size	npos
	This is a special value equal to the maximum value representable by the type size_t.
static constexpr xtd::size	npos
	This is a special value equal to the maximum value representable by the type size_t.
	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.
	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.
allocator_type	get_allocator () const noexcept
	Returns the associated allocator.
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	front ()
	Access the first element.
const_reference	front () const
	Access the first element.
reference	back ()
	Access the last element.
const_reference	back () const
	Access the last element.
pointer	data ()
	Direct access to the underlying array.
const_pointer	data () const
	Direct access to the underlying array.
iterator	begin () noexcept
	Returns an iterator to the beginning.
const_iterator	begin () const noexcept
	Returns an iterator to the beginning.
const_iterator	cbegin () const noexcept
	Returns an iterator to the beginning.
iterator	end () noexcept
	Returns an iterator to the end.
const_iterator	end () const noexcept
	Returns an iterator to the end.
const_iterator	cend () const noexcept
	Returns an iterator to the end.
reverse_iterator	rbegin () noexcept
	Returns a reverse iterator to the end.
const_reverse_iterator	rbegin () const noexcept
	Returns a reverse iterator to the end.
const_reverse_iterator	crbegin () const noexcept
	Returns a reverse iterator to the end.
reverse_iterator	rend () noexcept
	Returns a reverse iterator to the end.
const_reverse_iterator	rend () const noexcept
	Returns a reverse iterator to the end.
const_reverse_iterator	crend () const noexcept
	Returns a reverse iterator to the end.
bool	empty () const noexcept
	Checks whether the container is empty.
size_type	size () const noexcept
	Returns the number of elements.
size_type	max_size () const noexcept
	Returns the maximum possible number of elements.
void	reserve (size_type size)
	Reserves storage.
size_type	capacity () const noexcept
	Returns the number of elements that can be held in currently allocated storage.
void	shrink_to_fit ()
	Reduces memory usage by freeing unused memory.
virtual bool	sorted () const noexcept
	Checks whether the container is sorted.
virtual void	sorted (bool value)
	Sets the container is sorted.
virtual void	clear () noexcept
	clears the contents.
virtual iterator	insert (const_iterator pos, value_type &&value)
	Inserts specified element at specified position.
void	emplace (const_iterator pos, args_t &&... args)
	Inserts specified element at specified position.
void	emplace_back (args_t &&... args)
	Adds an element to the end.
virtual iterator	erase (iterator pos)
	Erases element at specified position.
virtual iterator	erase (const_iterator pos)
	Erases element at specified position.
virtual iterator	erase (iterator first, iterator last)
	Erases elements at specified range.
virtual iterator	erase (const_iterator first, const_iterator last)
	Erases elements at specified range.
virtual void	erase_at (size_t index)
	Erases element at specified index.
virtual void	pop_back ()
	Removes the last element of the container.
virtual void	push_back (value_type &&item)
	Adds an element to the end.
virtual void	push_back_range (const arranged_element_collection &collection)
	Adds elements to the end.
virtual void	push_back_range (const std::vector< value_type > &collection)
	Adds elements to the end.
virtual void	push_back_range (const std::initializer_list< value_type > &collection)
	Adds elements to the end.
void	push_back_range (collection_t &&collection)
	Adds elements to the end.
void	push_back_range (iterator_t begin, iterator_t end)
	Adds elements to the end.
virtual arranged_element_collection &	sort ()
	Sorts the content.
xtd::array< control_ref >	to_array () const noexcept
	Gets an array with the elements of the container.
std::vector< control_ref >	to_vector () const noexcept
	Gets an array with the elements of the container.
allocator_type	get_allocator () const noexcept
	Returns the associated allocator.
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	front ()
	Access the first element.
const_reference	front () const
	Access the first element.
reference	back ()
	Access the last element.
const_reference	back () const
	Access the last element.
pointer	data ()
	Direct access to the underlying array.
const_pointer	data () const
	Direct access to the underlying array.
iterator	begin () noexcept
	Returns an iterator to the beginning.
const_iterator	begin () const noexcept
	Returns an iterator to the beginning.
const_iterator	cbegin () const noexcept
	Returns an iterator to the beginning.
iterator	end () noexcept
	Returns an iterator to the end.
const_iterator	end () const noexcept
	Returns an iterator to the end.
const_iterator	cend () const noexcept
	Returns an iterator to the end.
reverse_iterator	rbegin () noexcept
	Returns a reverse iterator to the end.
const_reverse_iterator	rbegin () const noexcept
	Returns a reverse iterator to the end.
const_reverse_iterator	crbegin () const noexcept
	Returns a reverse iterator to the end.
reverse_iterator	rend () noexcept
	Returns a reverse iterator to the end.
const_reverse_iterator	rend () const noexcept
	Returns a reverse iterator to the end.
const_reverse_iterator	crend () const noexcept
	Returns a reverse iterator to the end.
bool	empty () const noexcept
	Checks whether the container is empty.
size_type	size () const noexcept
	Returns the number of elements.
size_type	max_size () const noexcept
	Returns the maximum possible number of elements.
void	reserve (size_type size)
	Reserves storage.
size_type	capacity () const noexcept
	Returns the number of elements that can be held in currently allocated storage.
void	shrink_to_fit ()
	Reduces memory usage by freeing unused memory.
virtual bool	sorted () const noexcept
	Checks whether the container is sorted.
virtual void	sorted (bool value)
	Sets the container is sorted.
virtual void	clear () noexcept
	clears the contents.
virtual iterator	insert (const_iterator pos, value_type &&value)
	Inserts specified element at specified position.
void	emplace (const_iterator pos, args_t &&... args)
	Inserts specified element at specified position.
void	emplace_back (args_t &&... args)
	Adds an element to the end.
virtual iterator	erase (iterator pos)
	Erases element at specified position.
virtual iterator	erase (const_iterator pos)
	Erases element at specified position.
virtual iterator	erase (iterator first, iterator last)
	Erases elements at specified range.
virtual iterator	erase (const_iterator first, const_iterator last)
	Erases elements at specified range.
virtual void	erase_at (size_t index)
	Erases element at specified index.
virtual void	pop_back ()
	Removes the last element of the container.
virtual void	push_back (value_type &&item)
	Adds an element to the end.
virtual void	push_back_range (const arranged_element_collection &collection)
	Adds elements to the end.
virtual void	push_back_range (const std::vector< value_type > &collection)
	Adds elements to the end.
virtual void	push_back_range (const std::initializer_list< value_type > &collection)
	Adds elements to the end.
void	push_back_range (collection_t &&collection)
	Adds elements to the end.
void	push_back_range (iterator_t begin, iterator_t end)
	Adds elements to the end.
virtual arranged_element_collection &	sort ()
	Sorts the content.
xtd::array< control_ref >	to_array () const noexcept
	Gets an array with the elements of the container.
std::vector< control_ref >	to_vector () const noexcept
	Gets an array with the elements of the container.
reference	operator[] (size_type pos)
	Access specified element.
const_reference	operator[] (size_type pos) const
	Access specified element.
reference	operator[] (size_type pos)
	Access specified element.
const_reference	operator[] (size_type pos) const
	Access specified element.
virtual void	on_item_added (size_t index, control_ref &item)
	Raises the xtd::forms::layout::arranged_element_collection::item_added event.
virtual void	on_item_updated (size_t index, control_ref &item)
	Raises the xtd::forms::layout::arranged_element_collection::item_updated event.
virtual void	on_item_added (size_t index, control_ref &item)
	Raises the xtd::forms::layout::arranged_element_collection::item_added event.
virtual void	on_item_updated (size_t index, control_ref &item)
	Raises the xtd::forms::layout::arranged_element_collection::item_updated event.
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual xtd::size	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.
template<class object_a_t, class object_b_t>
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<class object_a_t, class object_b_t>
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Member Typedef Documentation

base

using xtd::forms::control::control_collection::base

Represents the base type of the collection.

Constructor & Destructor Documentation

control_collection() [1/2]

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.

control_collection() [2/2]

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

explicit

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

Parameters

keep_cloned_controls	If true the collection clone and keep controls; otherwise none.
allocator	The allocator associate to the collection (optional).

Remarks

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

Warning

Internal use only

Member Function Documentation

operator[]() [1/2]

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

(

const xtd::string &

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.

operator[]() [2/2]

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

(

const xtd::string &

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.

emplace()

template<class control_t, class ... args_t>

control_t & xtd::forms::control::control_collection::emplace ( const_iterator pos, args_t &&... args )

inline

Creates and inserts specified control at specified position.

Parameters

pos	The iterator before which the content will be inserted. pos may be the xtd::forms::control::control_collection::end iterator.
args	The arguments to forward to the create method of the control

Returns

A reference to the created control.

Remarks

The control will be destroyed automatically when the control no longer has a parent.

For creation and insertion, this method uses the xtd::forms::control::create methods of the various controls.

Examples

The folowing example demonstartes the use of xtd::forms::control::control_collection::emplace, xtd::forms::control::control_collection::emplace_at and xtd::forms::control::control_collection::emplace_back methods.

#include <xtd/xtd>
 
auto main() -> int {
  auto button1_clicked = 0, button2_clicked = 0;
  auto form1 = form::create("Emplace example");
  form1.controls().emplace<button>(form1.controls().begin(), "Button 1", point{50, 50}).click += delegate_ {
    form1.controls()["label1"].value().get().text(string::format("Button 1 clicked {} times", ++button1_clicked));
  };
  form1.controls().emplace_at<button>(1, "Button 2", point {50, 100}, drawing::size {200, 75}).auto_repeat(true).click += delegate_ {
    form1.controls()["label2"].value().get().text(string::format("Button 2 clicked {} times", ++button2_clicked));
  };
  form1.controls().emplace<label>(form1.controls().end(), "Button 1 clicked 0 times", point {50, 200}, drawing::size {200, 23}, "label1");
  form1.controls().emplace_back<label>("Button 2 clicked 0 times", point {50, 230}, drawing::size {200, 23}, "label2");
  application::run(form1);
}

emplace_at()

template<class control_t, class ... args_t>

control_t & xtd::forms::control::control_collection::emplace_at ( size_t index, args_t &&... args )

inline

Creates and inserts specified control at specified position.

Parameters

index	The index before which the content will be inserted.
args	The arguments to forward to the create method of the control

Returns

A reference to the created control.

Remarks

The control will be destroyed automatically when the control no longer has a parent.

For creation and insertion, this method uses the xtd::forms::control::create methods of the various controls.

Examples

The folowing example demonstartes the use of xtd::forms::control::control_collection::emplace, xtd::forms::control::control_collection::emplace_at and xtd::forms::control::control_collection::emplace_back methods.

#include <xtd/xtd>
 
auto main() -> int {
  auto button1_clicked = 0, button2_clicked = 0;
  auto form1 = form::create("Emplace example");
  form1.controls().emplace<button>(form1.controls().begin(), "Button 1", point{50, 50}).click += delegate_ {
    form1.controls()["label1"].value().get().text(string::format("Button 1 clicked {} times", ++button1_clicked));
  };
  form1.controls().emplace_at<button>(1, "Button 2", point {50, 100}, drawing::size {200, 75}).auto_repeat(true).click += delegate_ {
    form1.controls()["label2"].value().get().text(string::format("Button 2 clicked {} times", ++button2_clicked));
  };
  form1.controls().emplace<label>(form1.controls().end(), "Button 1 clicked 0 times", point {50, 200}, drawing::size {200, 23}, "label1");
  form1.controls().emplace_back<label>("Button 2 clicked 0 times", point {50, 230}, drawing::size {200, 23}, "label2");
  application::run(form1);
}

emplace_back()

template<class control_t, class ... args_t>

control_t & xtd::forms::control::control_collection::emplace_back ( args_t &&... args )

inline

Creates and adds a control to the end.

Parameters

args	The arguments to forward to the create method of the control

Returns

A reference to the created control.

Remarks

The control will be destroyed automatically when the control no longer has a parent.

For creation and insertion, this method uses the xtd::forms::control::create methods of the various controls.

Examples

The folowing example demonstartes the use of xtd::forms::control::control_collection::emplace, xtd::forms::control::control_collection::emplace_at and xtd::forms::control::control_collection::emplace_back methods.

#include <xtd/xtd>
 
auto main() -> int {
  auto button1_clicked = 0, button2_clicked = 0;
  auto form1 = form::create("Emplace example");
  form1.controls().emplace<button>(form1.controls().begin(), "Button 1", point{50, 50}).click += delegate_ {
    form1.controls()["label1"].value().get().text(string::format("Button 1 clicked {} times", ++button1_clicked));
  };
  form1.controls().emplace_at<button>(1, "Button 2", point {50, 100}, drawing::size {200, 75}).auto_repeat(true).click += delegate_ {
    form1.controls()["label2"].value().get().text(string::format("Button 2 clicked {} times", ++button2_clicked));
  };
  form1.controls().emplace<label>(form1.controls().end(), "Button 1 clicked 0 times", point {50, 200}, drawing::size {200, 23}, "label1");
  form1.controls().emplace_back<label>("Button 2 clicked 0 times", point {50, 230}, drawing::size {200, 23}, "label2");
  application::run(form1);
}

insert()

iterator xtd::forms::control::control_collection::insert ( const_iterator pos, const value_type & value )

overridevirtual

Inserts specified element at specified position.

Parameters

pos	The iterator before which the content will be inserted. pos may be the arranged_element_collection::end iterator.
value	The element to insert.

Reimplemented from xtd::forms::layout::arranged_element_collection< control_ref >.

insert_at()

void xtd::forms::control::control_collection::insert_at ( size_t index, const value_type & value )

overridevirtual

Inserts specified element at specified index.

Parameters

index	The index before which the content will be inserted.
value	The element to insert.

Reimplemented from xtd::forms::layout::arranged_element_collection< control_ref >.

push_back()

void xtd::forms::control::control_collection::push_back ( const value_type & item )

overridevirtual

Adds an element to the end.

Parameters

item	The element to add.

Reimplemented from xtd::forms::layout::arranged_element_collection< control_ref >.

on_item_removed()

void xtd::forms::control::control_collection::on_item_removed ( size_t index, control_ref & item )

inlineoverrideprotectedvirtual

Raises the xtd::forms::layout::arranged_element_collection::item_removed event.

Parameters

index	The index of the item.
item	The item removed.

Reimplemented from xtd::forms::layout::arranged_element_collection< control_ref >.

---

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

• xtd.forms/include/xtd/forms/control.hpp