.. _program_listing_file_include_miral_miral_slow_keys.h:

Program Listing for File slow_keys.h
====================================

|exhale_lsh| :ref:`Return to documentation for file <file_include_miral_miral_slow_keys.h>` (``include/miral/miral/slow_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_SLOW_KEYS_H
   #define MIRAL_SLOW_KEYS_H
   
   #include <mir_toolkit/events/event.h>
   
   #include <chrono>
   #include <functional>
   
   namespace mir
   {
   class Server;
   }
   
   namespace miral
   {
   namespace live_config { class Store; }
   
   class SlowKeys
   {
   public:
       static auto enabled() -> SlowKeys;
   
       static auto disabled() -> SlowKeys;
   
       explicit SlowKeys(miral::live_config::Store& config_store);
   
       void operator()(mir::Server& server);
   
       // Enables slow keys.
       // When already enabled, further calls have no effect.
       SlowKeys& enable();
       
       // Disables slow keys.
       // When already disabled, further calls have no effect.
       SlowKeys& disable();
   
       SlowKeys& hold_delay(std::chrono::milliseconds hold_delay);
   
       SlowKeys& on_key_down(std::function<void(MirKeyboardEvent const*)>&& on_key_down);
       
       SlowKeys& on_key_rejected(std::function<void(MirKeyboardEvent const*)>&& on_key_rejected);
   
       SlowKeys& on_key_accepted(std::function<void(MirKeyboardEvent const*)>&& on_key_accepted);
   
   private:
       struct Self;
       explicit SlowKeys(std::shared_ptr<Self>);
       std::shared_ptr<Self> self;
   };
   }
   
   #endif // MIRAL_SLOW_KEYS_H