xref: /foundation/multimodalinput/input/interfaces/native/innerkits/event/include/switch_event.h

/*
 * Copyright (c) 2024 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef SWITCH_EVENT_H
#define SWITCH_EVENT_H

#include "nocopyable.h"

#include "input_event.h"

namespace OHOS {
namespace MMI {
class SwitchEvent : public InputEvent {
public:
    static constexpr int32_t SWITCH_ON = 0;
    static constexpr int32_t SWITCH_OFF = 1;

    /**
     * @brief Enumerated values of switch type.
    *
    * @since 12
    */
    enum SwitchType {
        /** Default, used to be compatible with calls to previously none switch type parameter */
        SWITCH_DEFAULT = 0,
        /** Lid switch type */
        SWITCH_LID,
        /** Tablet switch type */
        SWITCH_TABLET,
        /** Privacy switch type */
        SWITCH_PRIVACY
    };

public:
    int32_t GetSwitchType() const
    {
        return switchType_;
    }

    int32_t GetSwitchValue() const
    {
        return switchValue_;
    }

    int32_t GetSwitchMask() const
    {
        return updateSwitchMask_;
    }

    void SetSwitchType(int32_t type)
    {
        switchType_ = type;
    }

    void SetSwitchValue(int32_t value)
    {
        switchValue_ = value;
    }

    void SetSwitchMask(int32_t switchMask)
    {
        updateSwitchMask_ = switchMask;
    }

    virtual std::string ToString() override
    {
        std::string eventStr = InputEvent::ToString();
        eventStr += ",switchValue:" + std::to_string(switchValue_);
        eventStr += ",updateSwitchMask:" + std::to_string(updateSwitchMask_);
        eventStr += ",switchType:" + std::to_string(switchType_);
        return eventStr;
    }

    explicit SwitchEvent(int32_t value)
        : InputEvent(value),
        switchValue_(value),
        updateSwitchMask_(0),
        switchType_(SwitchType::SWITCH_DEFAULT) {}
private:
        int32_t switchValue_ { 0 };
        int32_t updateSwitchMask_ { 0 };
        int32_t switchType_ { SwitchType::SWITCH_DEFAULT };
};
} // namespace MMI
} // namespace OHOS
#endif // SWITCH_EVENT_H