checked_list_box.hpp

Go to the documentation of this file.

#pragma once
#include "item_check_event_handler.hpp"
#include "list_box.hpp"
#include <xtd/iequatable>

namespace xtd {
  namespace forms {
    class forms_export_ checked_list_box : public xtd::forms::list_box {
      struct data;
      
    public:
      class item : public xtd::forms::list_box::item, public xtd::icomparable<item>, public xtd::iequatable<item> {
      public:
        
        item() = default;
        item(const xtd::string& value); // Can't be explicit by design.
        item(const xtd::string& value, bool checked);
        item(const xtd::string& value, xtd::forms::check_state check_state);
        item(const xtd::string& value, const xtd::any_object& tag);
        item(const xtd::string& value, bool checked, const xtd::any_object& tag);
        item(const xtd::string& value, xtd::forms::check_state check_state, const xtd::any_object& tag);
        
        item(const char* value); // Can't be explicit by design.
        item(const item& value) = default;
        item& operator =(const item& value) = default;
        
        
        [[nodiscard]] virtual auto checked() const -> bool;
        
        [[nodiscard]] virtual auto check_state() const -> xtd::forms::check_state;
        
        
        using xtd::forms::list_box::item::compare_to;
        [[nodiscard]] auto compare_to(const item& value) const noexcept -> xtd::int32 override;
        using xtd::forms::list_box::item::equals;
        [[nodiscard]] auto equals(const item& value) const noexcept -> bool override;
        
      private:
        xtd::forms::check_state check_state_ = xtd::forms::check_state::unchecked;
      };
      
      
      using object_collection = layout::arranged_element_collection<item>;
      
      using checked_index_collection = xtd::collections::generic::list<xtd::usize>;
      
      using checked_item_collection = xtd::collections::generic::list<item>;
      
      using selected_object_collection = xtd::collections::generic::list<item>;
      
      
      checked_list_box();
      
      
      [[nodiscard]] auto checked_indices() const noexcept -> checked_index_collection;
      
      [[nodiscard]] auto checked_items() const noexcept -> checked_item_collection;
      
      [[nodiscard]] auto items() noexcept -> object_collection&;
      [[nodiscard]] auto items() const noexcept -> const object_collection&;
      auto items(const object_collection& value) -> const list_box&;
      
      using list_box::selected_index;
      auto selected_index(xtd::usize value) -> list_control& override;
      
      [[nodiscard]] auto selected_indices() const noexcept -> selected_index_collection override;
      
      [[nodiscard]] auto selected_item() const noexcept -> const item&;
      auto selected_item(const item& value) -> checked_list_box&;
      
      [[nodiscard]] auto selected_items() const noexcept -> selected_object_collection;
      
      using xtd::forms::list_box::text;
      auto text(const xtd::string& value) -> xtd::forms::control& override;
      
      
      auto begin_update() -> void;
      
      auto end_update() -> void;
      
      [[nodiscard]] auto get_item_checked(xtd::usize index) const -> bool;
      
      [[nodiscard]] auto get_item_check_state(xtd::usize index) const -> xtd::forms::check_state;
      
      [[nodiscard]] auto get_item_text(xtd::usize index) const -> const xtd::string&;
      
      auto set_item_checked(xtd::usize index, bool checked) -> void;
      
      auto set_item_check_state(xtd::usize index, xtd::forms::check_state check_state) -> void;
      
      auto set_item_text(xtd::usize index, const xtd::string& text) -> void;
      
      
      [[nodiscard]] static auto create() -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::drawing::point& location) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::drawing::point& location, const xtd::drawing::size& size) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) -> checked_list_box;
      [[nodiscard]] static auto create(const object_collection& items) -> checked_list_box;
      [[nodiscard]] static auto create(const object_collection& items, const xtd::drawing::point& location) -> checked_list_box;
      [[nodiscard]] static auto create(const object_collection& items, const xtd::drawing::point& location, const xtd::drawing::size& size) -> checked_list_box;
      [[nodiscard]] static auto create(const object_collection& items, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) -> checked_list_box;
      [[nodiscard]] static auto create(const object_collection& items, xtd::usize selected_index) -> checked_list_box;
      [[nodiscard]] static auto create(const object_collection& items, xtd::usize selected_index, const xtd::drawing::point& location) -> checked_list_box;
      [[nodiscard]] static auto create(const object_collection& items, xtd::usize selected_index, const xtd::drawing::point& location, const xtd::drawing::size& size) -> checked_list_box;
      [[nodiscard]] static auto create(const object_collection& items, xtd::usize selected_index, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const xtd::drawing::point& location) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const object_collection& items) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const object_collection& items, const xtd::drawing::point& location) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const object_collection& items, const xtd::drawing::point& location, const xtd::drawing::size& size) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const object_collection& items, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const object_collection& items, xtd::usize selected_index) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const object_collection& items, xtd::usize selected_index, const xtd::drawing::point& location) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const object_collection& items, xtd::usize selected_index, const xtd::drawing::point& location, const xtd::drawing::size& size) -> checked_list_box;
      [[nodiscard]] static auto create(const xtd::forms::control& parent, const object_collection& items, xtd::usize selected_index, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) -> checked_list_box;
      
      
      xtd::event<checked_list_box, xtd::forms::item_check_event_handler> item_check;
      
    protected:
      
      [[nodiscard]] auto allow_selection() const noexcept -> bool override;
      [[nodiscard]] auto create_params() const noexcept -> xtd::forms::create_params override;
      
      
      auto on_handle_created(const event_args& e) -> void override;
      
      virtual auto on_item_check(item_check_event_args& e) -> void;
      
      auto on_selected_value_changed(const event_args& e) -> void override;
      auto wnd_proc(message& message) -> void override;
      
    private:
      auto wm_command_control(message& message) -> void;
      auto wm_mouse_double_click(message& message) -> void;
      auto wm_mouse_down(message& message) -> void;
      auto wm_mouse_up(message& message) -> void;
      
      xtd::sptr<data> data_;
    };
  }
}