/*
* 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_radio_button.h
*
* @brief Defines the attributes and common functions of a radio button.
*
* @since 1.0
* @version 1.0
*/
#ifndef GRAPHIC_LITE_UI_RADIO_BUTTON_H
#define GRAPHIC_LITE_UI_RADIO_BUTTON_H
#include "components/ui_checkbox.h"
namespace OHOS {
/**
* @brief Represents a radio button.
*
* Only one option can be selected with the radio button.
*
* @see UICheckBox
* @since 1.0
* @version 1.0
*/
class UIRadioButton : public UICheckBox {
public:
/**
* @brief A constructor used to create a UIRadioButton instance.
*
* @since 1.0
* @version 1.0
*/
UIRadioButton();
/**
* @fn UIRadioButton::UIRadioButton(const char* name);
*
* @brief Default constructor
*/
explicit UIRadioButton(const char* name);
/**
* @brief A destructor used to delete the UIRadioButton instance.
*
* @since 1.0
* @version 1.0
*/
virtual ~UIRadioButton()
{
if (name_ != nullptr) {
UIFree(name_);
name_ = nullptr;
}
}
/**
* @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_RADIO_BUTTON;
}
bool OnPreDraw(Rect& invalidatedArea) const override
{
return false;
}
void OnDraw(BufferInfo& gfxDstBuffer, const Rect& invalidatedArea) override;
/**
* @fn virtual void UIRadioButton::OnClickEvent(const ClickEvent& event) override;
*
* @brief Executes the click event action
* OnClickEvent will reverse the selected state of checkbox.
* Example: If the check box is selected, the checkbox status is changed to
* Unselected after the click action is taken.
*
* @param event The event that passed when OnClickEvent is invoked.
* @return Returns true if the event is consumed; returns false otherwise.
*/
bool OnClickEvent(const ClickEvent& event) override;
/**
* @brief Sets the name for this radio button.
*
* @param name Indicates the name to set, which is a character string.
* @since 1.0
* @version 1.0
*/
void SetName(const char* name);
/**
* @brief Obtains the name of this radio button.
*
* @return Returns the name of this radio button, which is a defined character string. Radio buttons sharing the
* same name are in the same batch from which only one can be selected.
* @since 1.0
* @version 1.0
*/
const char* GetName() const
{
return name_;
}
protected:
void CalculateSize() override;
#if DEFAULT_ANIMATION
void Callback(UIView* view) override;
#endif
private:
void FindRadioButtonAndChangeState(UIView* view);
char* name_;
uint16_t radiusBig_;
uint16_t radiusSmall_;
uint16_t currentRadius_;
int16_t lineWidth_;
};
} // namespace OHOS
#endif // GRAPHIC_LITE_UI_RADIO_BUTTON_H