ui_label_button.h 7.3 KB
Newer Older
M
mamingshuai 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
/*
 * 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_label_button.h
 *
 * @brief Declares a label button.
 *
 * @since 1.0
 * @version 1.0
 */

#ifndef GRAPHIC_LITE_UI_LABEL_BUTTON_H
#define GRAPHIC_LITE_UI_LABEL_BUTTON_H

#include "common/text.h"
#include "components/ui_button.h"
40
#include "gfx_utils/graphic_log.h"
M
mamingshuai 已提交
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

namespace OHOS {
/**
 * @brief Provides the functions related to a label button.
 *
 * @since 1.0
 * @version 1.0
 */
class UILabelButton : public UIButton {
public:
    /**
     * @brief A constructor used to create a <b>UILabelButton</b> instance.
     *
     * @since 1.0
     * @version 1.0
     */
    UILabelButton();

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

    /**
     * @brief Draws a label button.
     *
     * @since 1.0
     * @version 1.0
     */
N
niulihua 已提交
73
    void OnDraw(BufferInfo& gfxDstBuffer, const Rect& invalidatedArea) override;
M
mamingshuai 已提交
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119

    /**
     * @brief Obtains the view type.
     *
     * @return Returns <b>UI_LABEL_BUTTON</b>, as defined in {@link UIViewType}.
     * @since 1.0
     * @version 1.0
     */
    UIViewType GetViewType() const override
    {
        return UI_LABEL_BUTTON;
    }

    /**
     * @brief Sets the text for this label button.
     *
     * @param text Indicates the pointer to the text.
     * @since 1.0
     * @version 1.0
     */
    void SetText(const char* text)
    {
        InitLabelButtonText();
        labelButtonText_->SetText(text);
    }

    /**
     * @brief Obtains the text of this label button.
     *
     * @return Returns the text.
     * @since 1.0
     * @version 1.0
     */
    const char* GetText() const
    {
        return (labelButtonText_ == nullptr) ? nullptr : labelButtonText_->GetText();
    }

    /**
     * @brief Sets the position for this label relative to the button holding it.
     *
     * @param x Indicates the offset distance by which this label is moved on the x-axis.
     * @param y Indicates the offset distance by which this label is moved on the y-axis.
     * @since 1.0
     * @version 1.0
     */
L
lancer 已提交
120
    void SetLabelPosition(int16_t x, int16_t y)
M
mamingshuai 已提交
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
    {
        offset_.x = x;
        offset_.y = y;
    }

    /**
     * @brief Obtains the position of this label relative to the button holding it.
     *
     * @return Returns the position of this label.
     * @since 1.0
     * @version 1.0
     */
    Point GetLabelPosition() const
    {
        return offset_;
    }

    /**
     * @brief Sets the alignment mode for this text.
     *
     * @param align Indicates the text alignment mode to set, as defined in {@link UITextLanguageAlignment}.
     * @since 1.0
     * @version 1.0
     */
    void SetAlign(UITextLanguageAlignment align)
    {
        InitLabelButtonText();
        labelButtonText_->SetAlign(align, TEXT_ALIGNMENT_CENTER);
    }

    /**
     * @brief Obtains the alignment mode of this text.
     *
     * @return Returns the text alignment mode, as defined in {@link UITextLanguageAlignment}.
     * @since 1.0
     * @version 1.0
     */
    UITextLanguageAlignment GetAlign()
    {
        InitLabelButtonText();
        return labelButtonText_->GetHorAlign();
    }

    /**
     * @brief Sets the direction for this text.
     *
     * @param direct Indicates the text direction to set, as defined in {@link UITextLanguageDirect}.
     * @since 1.0
     * @version 1.0
     */
    void SetDirect(UITextLanguageDirect direct)
    {
        InitLabelButtonText();
        labelButtonText_->SetDirect(direct);
    }

    /**
     * @brief Obtains the direction of this text.
     *
     * @return Returns the text direction, as defined in {@link UITextLanguageDirect}.
     * @since 1.0
     * @version 1.0
     */
    UITextLanguageDirect GetDirect()
    {
        InitLabelButtonText();
        return labelButtonText_->GetDirect();
    }

    /**
     * @brief Sets the style for this label.
     *
     * @param labelStyle Indicates the label style to set.
     * @since 1.0
     * @version 1.0
     */
    void SetLabelStyle(Style& labelStyle)
    {
        labelStyle_ = labelStyle;
    }

    /**
     * @brief Sets a style for this label.
     *
     * @param key Indicates the key of the style to set.
     * @param value Indicates the value matching the key.
     * @since 1.0
     * @version 1.0
     */
    void SetLabelStyle(uint8_t key, int64_t value)
    {
        labelStyle_.SetStyle(key, value);
    }

    /**
     * @brief Obtains the style of this label.
     *
     * @return Returns the label style.
     * @since 1.0
     * @version 1.0
     */
    const Style& GetLabelStyle() const
    {
        return labelStyle_;
    }

    /**
     * @brief Obtains the value of a style of this label.
     *
     * @param key Indicates the key of the style.
     * @return Returns the value of the style.
     * @since 1.0
     * @version 1.0
     */
    int64_t GetLabelStyle(uint8_t key) const
    {
        return labelStyle_.GetStyle(key);
    }

    /**
     * @brief Sets the color for this text.
     *
     * @param color Indicates the text color to set.
     * @since 1.0
     * @version 1.0
     */
    void SetTextColor(ColorType color)
    {
        labelStyle_.textColor_ = color;
    }

    /**
     * @brief Sets the font for this text.
     *
     * @param name Indicates the pointer to the font name.
     * @param size Indicates the font size to set.
     * @since 1.0
     * @version 1.0
     */
    void SetFont(const char* name, uint8_t size)
    {
        InitLabelButtonText();
        labelButtonText_->SetFont(name, size);
    }

    /**
     * @brief Sets the font ID.
     *
     * @param fontId Indicates the font ID composed of the font name and size.
     * @since 1.0
     * @version 1.0
     */
    void SetFontId(uint8_t fontId)
    {
        InitLabelButtonText();
        labelButtonText_->SetFontId(fontId);
    }

    /**
     * @brief Obtains the font ID.
     *
     * @return Returns the front ID composed of the font name and size.
     * @since 1.0
     * @version 1.0
     */
    uint8_t GetFontId()
    {
        InitLabelButtonText();
        return labelButtonText_->GetFontId();
    }

protected:
293 294 295 296 297 298 299 300 301 302 303
    virtual void InitLabelButtonText()
    {
        if (labelButtonText_ == nullptr) {
            labelButtonText_ = new Text();
            if (labelButtonText_ == nullptr) {
                GRAPHIC_LOGE("new Text fail");
                return;
            }
            labelButtonText_->SetAlign(TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_CENTER);
        }
    }
M
mamingshuai 已提交
304 305 306 307 308 309 310 311 312

    Text* labelButtonText_;

private:
    Style labelStyle_;
    Point offset_; /* Text draw position offset */
};
} // namespace OHOS
#endif // GRAPHIC_LITE_UI_LABEL_BUTTON_H