/*
 * 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_Components
 * @{
 *
 * @brief Defines UI components such as buttons, texts, images, lists, and progress bars.
 *
 * @since 1.0
 * @version 1.0
 */

/**
 * @file ui_toggle_button.h
 *
 * @brief Defines the attributes and common functions of a toggle button.
 *
 * Each toggle button contains two images, one for pressing and the other for releasing.
 *
 * @since 1.0
 * @version 1.0
 */

#ifndef GRAPHIC_LITE_UI_TOGGLE_BUTTON_H
#define GRAPHIC_LITE_UI_TOGGLE_BUTTON_H

#include "components/ui_checkbox.h"
#include "components/ui_image_view.h"

namespace OHOS {
/**
 * @brief Represents a toggle button.
 *
 * Each toggle button contains two images, one for pressing and the other for releasing.
 *
 * @see UICheckBox
 * @since 1.0
 * @version 1.0
 */
class UIToggleButton : public UICheckBox {
public:
    /**
     * @brief A constructor used to create a <b>UIToggleButton</b> instance.
     *
     * @since 1.0
     * @version 1.0
     */
    UIToggleButton();

    /**
     * @brief A destructor used to delete the <b>UIToggleButton</b> instance.
     *
     * @since 1.0
     * @version 1.0
     */
    virtual ~UIToggleButton() {}

    /**
     * @brief Obtains the component type.
     *
     * @return Returns the component type, as defined in {@link UIViewType}.
     * @since 1.0
     * @version 1.0
     */
    UIViewType GetViewType() const override
    {
        return UI_TOGGLE_BUTTON;
    }

    void OnDraw(BufferInfo& gfxDstBuffer, const Rect& invalidatedArea) override;

    /**
     * @brief Sets the state for this toggle button.
     *
     * @param state Indicates the state of this toggle button. The value <b>true</b> indicates the image displayed for
     * <b>On</b>, and <b>false</b> indicates the image displayed for <b>Off</b>. If this function is not called, the
     * image is displayed for <b>Off</b>.
     * @since 1.0
     * @version 1.0
     */
    void SetState(bool state);

    /**
     * @brief Obtains the state of this toggle button.
     *
     * @return Returns <b>true</b> if the image for <b>On</b> is displayed; returns <b>false</b> if the image is
     * displayed for <b>Off</b>.
     * @since 1.0
     * @version 1.0 */
    bool GetState() const
    {
        return (state_ != UNSELECTED);
    }

protected:
    void CalculateSize() override;

private:
    static constexpr int16_t DEFAULT_WIDTH = 32;
    static constexpr int16_t DEFAULT_CORNER_RADIUS = 11;
    static constexpr int16_t DEAFULT_RADIUS_DIFF = 2;
    static constexpr uint8_t DEFAULT_UNSELECTED_OPA = 97;

    uint16_t corner_;
    uint16_t radius_;
    int16_t rectWidth_;
}; // class UIToggleButton
} // namespace OHOS
#endif // GRAPHIC_LITE_UI_TOGGLE_BUTTON_H