xref: /foundation/arkui/ui_lite/interfaces/kits/events/cancel_event.h

/*
 * Copyright (c) 2020-2021 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.
 */

/**
 * @addtogroup UI_Events
 * @{
 *
 * @brief Defines UI events, such as press, click and drag events.
 *
 * @since 1.0
 * @version 1.0
 */

/**
 * @file cancel_event.h
 *
 * @brief Declares a cancel event, which usually occurs when the target view changes due to user sliding. For example,
          this event is triggered if you, after pressing a button, does not release the button but slides.
 *
 * @since 1.0
 * @version 1.0
 */

#ifndef GRAPHIC_LITE_CANCEL_EVENT_H
#define GRAPHIC_LITE_CANCEL_EVENT_H

#include "event.h"

namespace OHOS {
/**
 * @brief Defines a cancel event, which usually occurs when the target view changes due to user sliding. For example,
          this event is triggered if you, after pressing a button, does not release the button but slides.
 * @since 1.0
 * @version 1.0
 */
class CancelEvent : public Event {
public:
    /**
     * @brief A constructor used to create a <b>CancelEvent</b> instance.
     * @param pos Indicates the position where the cancel event occurs.
     * @since 1.0
     * @version 1.0
     */
    CancelEvent(const Point& pos) : Event(pos) {}

    /**
     * @brief A destructor used to delete the <b>CancelEvent</b> instance.
     * @since 1.0
     * @version 1.0
     */
    virtual ~CancelEvent() {}
};
} // namespace OHOS
#endif // GRAPHIC_LITE_CANCEL_EVENT_H