Class XModifierKey

cpp/webdriver-interactions/interactions_linux.cpp:45–73

This class represents a single modifier key. A modifier key is Shift, Ctrl or Alt. A key has, besides a GDK symbol related to it, a Mask that must be appended to each keyboard event when this modifier is set.

// that must be appended to each keyboard event when this modifier is
// set.
class XModifierKey
{
 public:
  // Stores the key associated with this modifier and the bit-mask
  // to set when this key was toggled.
  XModifierKey(const guint& associated_gdk_key, const GdkModifierType& gdk_mod,
    const guint32& stored_state);
  // if a_key matches the associated gdk key, toggeles the modifier
  // key state.
  void ToggleIfKeyMatches(const guint a_key);
  // Returns true if the key given matches the key associated with
  // this modifier.
  bool KeyMatches(const guint a_key) const;
  // if the modifier key was pressed, return the mask to OR with.
  // If not, return 0.
  guint GetAppropriateMask() const;
  // Set the modifier to false.
  void ClearModifier();
  // Returns the associated key
  guint get_associated_key() const;
  // Returns true if the modifier is set, false otherwise.
  bool get_toggle() const;
  // Store the current state of the modifier key into the provided int.
  void StoreState(guint32* state_store) const;
 private:
  bool toggle_;
  guint associated_key_;
  GdkModifierType gdk_mod_mask_;
};

XModifierKey::XModifierKey(const guint& associated_gdk_key,
                           const GdkModifierType& gdk_mod,