key_event_args.hpp

Go to the documentation of this file.

#pragma once
#include "keys.hpp"
#include <xtd/event_args>

namespace xtd {
  namespace forms {
    class key_event_args : public xtd::event_args {
    public:
      
      key_event_args() = default;
      explicit key_event_args(xtd::forms::keys key_data) : key_data_(key_data) {}
 
      
      
      [[nodiscard]] auto alt() const noexcept -> bool {return (key_data_ & xtd::forms::keys::alt) == keys::alt;}
      
      [[nodiscard]] auto command() const noexcept -> bool {return (key_data_ & xtd::forms::keys::command) == keys::command;}
      
      [[nodiscard]] auto control() const noexcept -> bool {return (key_data_ & xtd::forms::keys::control) == keys::control;}
      
      [[nodiscard]] auto handled() const noexcept -> bool {return handled_;}
      auto handled(bool value) -> key_event_args& {
        handled_ = value;
        return *this;
      }
      
      [[nodiscard]] auto key_code() const noexcept -> xtd::forms::keys {return key_data_ & xtd::forms::keys::key_code;}
      
      [[nodiscard]] auto key_data() const noexcept -> xtd::forms::keys {return key_data_;}
      
      [[nodiscard]] auto key_value() const noexcept -> xtd::int32 {return static_cast<xtd::int32>(key_data_) & 0xFFFF;}
      
      [[nodiscard]] auto modifiers() const noexcept -> xtd::forms::keys {return key_data_ & xtd::forms::keys::modifiers;}
      
      [[nodiscard]] auto shift() const noexcept -> bool {return (key_data_ & xtd::forms::keys::shift) == keys::shift;}
      
      [[nodiscard]] auto suppress_key_press() const noexcept -> bool {return suppress_key_press_;}
      auto suppress_key_press(bool value) -> key_event_args& {
        suppress_key_press_ = value;
        if (value) handled(true);
        return *this;
      }

      
    private:
      xtd::forms::keys key_data_ = xtd::forms::keys::none;
      bool handled_ = false;
      bool suppress_key_press_ = false;
    };
  }
}