Program Listing for File mousekeys_config.h

↰ Return to documentation for file (/home/docs/checkouts/readthedocs.org/user_builds/canonical-mir/checkouts/stable/include/miral/miral/mousekeys_config.h)

/*
 * 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_MOUSE_KEYS_CONFIG_H
#define MIRAL_MOUSE_KEYS_CONFIG_H

#include <mir/input/mousekeys_keymap.h>

#include <memory>

namespace mir
{
class Server;
}

namespace miral
{
namespace live_config
{
    class Store;
}
class MouseKeysConfig
{
public:
    [[deprecated(
        "MouseKeysConfig(bool) is deprecated. Please use MouseKeysConfig::enabled or MouseKeysConfig::disabled")]]
    explicit MouseKeysConfig(bool enabled_by_default);

    auto static enabled() -> MouseKeysConfig;

    auto static disabled() -> MouseKeysConfig;

    explicit MouseKeysConfig(live_config::Store& config_store);

    void operator()(mir::Server& server) const;

    [[deprecated(
        "MouseKeysConfig::enabled(bool) is deprecated. Please use MouseKeysConfig::enable or MouseKeysConfig::disable")]]
    void enabled(bool enabled) const;

    void enable() const;

    void disable() const;

    void set_keymap(mir::input::MouseKeysKeymap const& new_keymap) const;

    void set_acceleration_factors(double constant, double linear, double quadratic) const;

    void set_max_speed(double x_axis, double y_axis) const;

private:
    struct Self;
    MouseKeysConfig(std::shared_ptr<Self>);
    std::shared_ptr<Self> self;
};
}

#endif