1 #ifndef DALI_TOOLKIT_INTERNAL_VISUAL_URL_H
2 #define DALI_TOOLKIT_INTERNAL_VISUAL_URL_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
32 * The type of the URL based on the string contents
47 LOCAL, ///< file in local file system
48 TEXTURE, ///< texture uploaded to texture manager
49 REMOTE, ///< remote image
50 BUFFER ///< encoded image buffer
54 * Default Constructor.
55 * Resulting URL is not valid
61 * Delete an external texture if if protocolType is TEXTURE.
67 * Determines type of visual and whether the url is local or remote
68 * Notify that it is using an external texture if if protocolType is TEXTURE.
70 * @param[in] url The URL to store and resolve
72 VisualUrl(const std::string& url);
76 * @param[in] url The VisualUrl to copy
78 VisualUrl(const VisualUrl& url);
82 * @param[in] url The VisualUrl to copy
84 VisualUrl& operator=(const VisualUrl& url);
90 const std::string& GetUrl() const;
93 * Get the visual type of the URL
94 * @return The visual type of the URL
99 * Is the URL is local to the device, or remote?
100 * @return the location of the resource
102 ProtocolType GetProtocolType() const;
106 * @return true if the URL has length
108 bool IsValid() const;
111 * @return true if the location is LOCAL, i.e. is loadable from local file system
113 bool IsLocalResource() const;
116 * @return true if the location is BUFFER, i.e. may contain EncodedImageBuffer
118 bool IsBufferResource() const;
121 * @return the location part of the url
123 std::string GetLocation() const;
126 * Helper to create a URL of type TEXTURE
127 * @param location the location of the texture
130 static std::string CreateTextureUrl(const std::string& location);
133 * Helper to create a URL of type BUFFER
134 * @param location the location of the texture
137 static std::string CreateBufferUrl(const std::string& location);
140 * Helper to get a ProtocolType from url
141 * @param url the url of the texture
142 * @return the protocol type
144 static VisualUrl::ProtocolType GetProtocolType(const std::string& url);
147 * Helper to get a location from url
148 * @param url the location of the texture
149 * @return the location
151 static std::string GetLocation(const std::string& url);
156 ProtocolType mLocation;
159 } // namespace Internal
161 } // namespace Toolkit
165 #endif /* DALI_TOOLKIT_INTERNAL_VISUAL_URL_H */