checked_list_box.h

Go to the documentation of this file.

 
#pragma once
#include "item_check_event_handler.h"
#include "list_box.h"
#include <xtd/iequatable>
 
namespace xtd {
  namespace forms {
    class forms_export_ checked_list_box : public list_box {
      struct data;
      
    public:
      class item : public list_box::item, public xtd::icomparable<item>, public xtd::iequatable<item> {
      public:
        
        item() = default;
        item(const xtd::ustring& value); // Can't be explicit by design.
        item(const xtd::ustring& value, bool checked);
        item(const xtd::ustring& value, forms::check_state check_state);
        item(const xtd::ustring& value, const std::any& tag);
        item(const xtd::ustring& value, bool checked, const std::any& tag);
        item(const xtd::ustring& value, forms::check_state check_state, const std::any& tag);
        
        item(const char* value); // Can't be explicit by design.
        item(const item& value) = default;
        item& operator =(const item& value) = default;
        
        
        virtual bool checked() const;
        
        virtual forms::check_state check_state() const;
        
        
        using list_box::item::compare_to;
        int32 compare_to(const item& value) const noexcept override;
        using list_box::item::equals;
        bool equals(const item& value) const noexcept override;
        
      private:
        forms::check_state check_state_ = forms::check_state::unchecked;
      };
      
      
      using object_collection = layout::arranged_element_collection<item>;
      
      using checked_index_collection = std::vector<size_t>;
      
      using checked_item_collection = std::vector<item>;
      
      using selected_object_collection = std::vector<item>;
      
      
      checked_list_box();
      
      checked_list_box(checked_list_box&& rhs);
      checked_list_box(const checked_list_box&) = default;
      checked_list_box& operator =(const checked_list_box&) = default;
 
      
      checked_index_collection checked_indices() const noexcept;
      
      checked_item_collection checked_items() const noexcept;
      
      object_collection& items() noexcept;
      const object_collection& items() const noexcept;
      const list_box& items(const object_collection& items);
      
      using list_box::selected_index;
      list_control& selected_index(size_t selected_index) override;
      
      std::vector<size_t> selected_indices() const noexcept override;
      
      const item& selected_item() const noexcept;
      checked_list_box& selected_item(const item& selected_item);
      
      selected_object_collection selected_items() const noexcept;
      
      using list_box::text;
      control& text(const xtd::ustring& text) override;
      
      
      void begin_update();
 
      void end_update();
      
      bool get_item_checked(size_t index) const;
      
      forms::check_state get_item_check_state(size_t index) const;
      
      const xtd::ustring& get_item_text(size_t index) const;
      
      void set_item_checked(size_t index, bool checked);
      
      void set_item_check_state(size_t index, forms::check_state check_state);
      
      void set_item_text(size_t index, const xtd::ustring& text);
      
      
      static checked_list_box create();
      static checked_list_box create(const drawing::point& location);
      static checked_list_box create(const drawing::point& location, const drawing::size& size);
      static checked_list_box create(const drawing::point& location, const drawing::size& size, const xtd::ustring& name);
      static checked_list_box create(const object_collection& items);
      static checked_list_box create(const object_collection& items, const drawing::point& location);
      static checked_list_box create(const object_collection& items, const drawing::point& location, const drawing::size& size);
      static checked_list_box create(const object_collection& items, const drawing::point& location, const drawing::size& size, const xtd::ustring& name);
      static checked_list_box create(const object_collection& items, size_t selected_index);
      static checked_list_box create(const object_collection& items, size_t selected_index, const drawing::point& location);
      static checked_list_box create(const object_collection& items, size_t selected_index, const drawing::point& location, const drawing::size& size);
      static checked_list_box create(const object_collection& items, size_t selected_index, const drawing::point& location, const drawing::size& size, const xtd::ustring& name);
      static checked_list_box create(const control& parent);
      static checked_list_box create(const control& parent, const drawing::point& location);
      static checked_list_box create(const control& parent, const drawing::point& location, const drawing::size& size);
      static checked_list_box create(const control& parent, const drawing::point& location, const drawing::size& size, const xtd::ustring& name);
      static checked_list_box create(const control& parent, const object_collection& items);
      static checked_list_box create(const control& parent, const object_collection& items, const drawing::point& location);
      static checked_list_box create(const control& parent, const object_collection& items, const drawing::point& location, const drawing::size& size);
      static checked_list_box create(const control& parent, const object_collection& items, const drawing::point& location, const drawing::size& size, const xtd::ustring& name);
      static checked_list_box create(const control& parent, const object_collection& items, size_t selected_index);
      static checked_list_box create(const control& parent, const object_collection& items, size_t selected_index, const drawing::point& location);
      static checked_list_box create(const control& parent, const object_collection& items, size_t selected_index, const drawing::point& location, const drawing::size& size);
      static checked_list_box create(const control& parent, const object_collection& items, size_t selected_index, const drawing::point& location, const drawing::size& size, const xtd::ustring& name);
      
      
      event<checked_list_box, item_check_event_handler> item_check;
      
    protected:
      
      bool allow_selection() const noexcept override;
      forms::create_params create_params() const noexcept override;
      
      
      std::unique_ptr<xtd::object> clone() const override;
      
      void on_handle_created(const event_args& e) override;
      
      virtual void on_item_check(item_check_event_args& e);
      
      void on_selected_value_changed(const event_args& e) override;
      void wnd_proc(message& message) override;
      
    private:
      void on_items_item_added(size_t pos, const item& item);
      void on_items_item_removed(size_t pos, const item& item);
      void on_items_item_updated(size_t pos, const item& item);
      void wm_command_control(message& message);
      void wm_mouse_double_click(message& message);
      void wm_mouse_down(message& message);
      void wm_mouse_up(message& message);
      
      std::shared_ptr<data> data_;
    };
  }
}