.. _program_listing_file_include_miral_miral_sticky_keys.h:

Program Listing for File sticky_keys.h
======================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_miral_miral_sticky_keys.h>` (``include/miral/miral/sticky_keys.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /*
    * Copyright © Canonical Ltd.
    *
    * This program is free software: you can redistribute it and/or modify it
    * under the terms of the GNU General Public License version 2 or 3 as
    * published by the Free Software Foundation.
    *
    * This program is distributed in the hope that it will be useful,
    * but WITHOUT ANY WARRANTY; without even the implied warranty of
    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    * GNU General Public License for more details.
    *
    * You should have received a copy of the GNU General Public License
    * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    */
   
   #ifndef MIRAL_STICKY_KEYS_H
   #define MIRAL_STICKY_KEYS_H
   
   #include <memory>
   #include <functional>
   
   namespace mir
   {
   class Server;
   }
   
   namespace miral
   {
   namespace live_config { class Store; }
   
   class StickyKeys
   {
   public:
       static auto enabled() -> StickyKeys;
   
       // Creates a 'StickyKeys' instance that is disabled by default.
       static auto disabled() -> StickyKeys;
   
       explicit StickyKeys(live_config::Store& config_store);
   
       void operator()(mir::Server& server);
   
       StickyKeys& enable();
   
       StickyKeys& disable();
   
       StickyKeys& should_disable_if_two_keys_are_pressed_together(bool on);
   
       StickyKeys& on_modifier_clicked(std::function<void(int32_t)>&&);
   
   private:
       class Self;
       explicit StickyKeys(std::shared_ptr<Self>);
       std::shared_ptr<Self> self;
   };
   }
   
   #endif //MIRAL_STICKY_KEYS_H