Program Listing for File mir_keyboard_config.h

↰ Return to documentation for file (/home/docs/checkouts/readthedocs.org/user_builds/canonical-mir-documentation/checkouts/2.30/include/common/mir/input/mir_keyboard_config.h)

/*
 * Copyright © Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef MIR_INPUT_KEYBOARD_CONFIGURATION_H_
#define MIR_INPUT_KEYBOARD_CONFIGURATION_H_

#include <mir_toolkit/common.h>
#include <mir_toolkit/mir_input_device_types.h>
#include <mir/input/keymap.h>

#include <iosfwd>
#include <memory>

/*
 * Keyboard device configuration.
 */
struct MirKeyboardConfig
{
    MirKeyboardConfig();
    ~MirKeyboardConfig();
    MirKeyboardConfig(std::shared_ptr<mir::input::Keymap> keymap);
    MirKeyboardConfig(MirKeyboardConfig&& other);
    MirKeyboardConfig(MirKeyboardConfig const& other);
    MirKeyboardConfig& operator=(MirKeyboardConfig const& other);

    void device_keymap(std::shared_ptr<mir::input::Keymap> keymap);
    auto device_keymap() const -> std::shared_ptr<mir::input::Keymap> const&;

    bool operator==(MirKeyboardConfig const& rhs) const;

private:
    struct Implementation;
    std::unique_ptr<Implementation> impl;
};

std::ostream& operator<<(std::ostream& out, MirKeyboardConfig const& keyboard);

#endif