1 /*
2  * Copyright (c) 2022 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_MARQUEE_MODEL_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_MARQUEE_MODEL_H
18 
19 #include <mutex>
20 #include <optional>
21 
22 #include "base/geometry/dimension.h"
23 #include "core/components/common/layout/constants.h"
24 #include "core/components/common/properties/color.h"
25 #include "core/components/common/properties/text_style.h"
26 
27 namespace OHOS::Ace {
28 class ACE_FORCE_EXPORT MarqueeModel {
29 public:
30     static MarqueeModel* GetInstance();
31     virtual ~MarqueeModel() = default;
32 
33     virtual void Create() = 0;
34     virtual void SetValue(const std::optional<std::string>& value) = 0;
35     virtual void SetPlayerStatus(const std::optional<bool>& playerStatus) = 0;
36     virtual void SetScrollAmount(const std::optional<double>& scrollAmount) = 0;
37     virtual void SetLoop(const std::optional<int32_t>& loop) = 0;
38     virtual void SetDirection(const std::optional<MarqueeDirection>& direction) = 0;
39     virtual void SetTextColor(const std::optional<Color>& textColor) = 0;
40     virtual void SetFontSize(const std::optional<Dimension>& fontSize) = 0;
41     virtual void SetFontWeight(const std::optional<FontWeight>& fontWeight) = 0;
42     virtual void SetFontFamily(const std::optional<std::vector<std::string>>& fontFamilies) = 0;
43     virtual void SetAllowScale(const std::optional<bool>& allowScale) = 0;
44     virtual void SetOnStart(std::function<void()>&& onChange) = 0;
45     virtual void SetOnBounce(std::function<void()>&& onChange) = 0;
46     virtual void SetOnFinish(std::function<void()>&& onChange) = 0;
SetMarqueeUpdateStrategy(const std::optional<MarqueeUpdateStrategy> & marqueeUpdateStrategy)47     virtual void SetMarqueeUpdateStrategy(const std::optional<MarqueeUpdateStrategy>& marqueeUpdateStrategy) {};
48 
49 private:
50     static std::unique_ptr<MarqueeModel> instance_;
51     static std::mutex mutex_;
52 };
53 } // namespace OHOS::Ace
54 
55 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_PATTERNS_MARQUEE_MODEL_H
56