Program Listing for File idle_listener.h

↰ Return to documentation for file (/home/docs/checkouts/readthedocs.org/user_builds/canonical-mir-documentation/checkouts/2.30/include/miral/miral/idle_listener.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_IDLE_LISTENER_H
#define MIRAL_IDLE_LISTENER_H

#include <functional>
#include <memory>

namespace mir { class Server; }

namespace miral
{

class IdleListener
{
public:
    using Callback = std::function<void()>;

    IdleListener();
    ~IdleListener() = default;
    IdleListener& on_dim(Callback const&);
    IdleListener& on_off(Callback const&);
    IdleListener& on_wake(Callback const&);

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

private:
    struct Impl;
    std::shared_ptr<Impl> self;
};
}

#endif //MIRAL_IDLE_LISTENER_H