Program Listing for File mir_pointer_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_pointer_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_POINTER_CONFIGURATION_H_
#define MIR_INPUT_POINTER_CONFIGURATION_H_

#include <mir_toolkit/common.h>
#include <mir_toolkit/mir_input_device_types.h>

#include <memory>
#include <iosfwd>

struct MirPointerConfig
{
    MirPointerConfig();
    ~MirPointerConfig();
    MirPointerConfig(MirPointerConfig const& cp);
    MirPointerConfig(MirPointerConfig&& cp);
    MirPointerConfig& operator=(MirPointerConfig const& cp);
    MirPointerConfig(
        MirPointerHandedness handedness,
        MirPointerAcceleration acceleration,
        double acceleration_bias,
        double horizontal_scroll_scale,
        double vertical_scroll_scale);
    MirPointerHandedness handedness() const;
    void handedness(MirPointerHandedness);

    MirPointerAcceleration acceleration() const;
    void acceleration(MirPointerAcceleration);

    double cursor_acceleration_bias() const;
    void cursor_acceleration_bias(double);

    double horizontal_scroll_scale() const;
    void horizontal_scroll_scale(double);

    double vertical_scroll_scale() const;
    void vertical_scroll_scale(double);

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

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

std::ostream& operator<<(std::ostream& out, MirPointerConfig const& rhs);

#endif