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
46 LOCAL, ///< file in local file system
47 TEXTURE, ///< texture uploaded to texture manager
48 REMOTE, ///< remote image
49 BUFFER ///< encoded image buffer
53 * Default Constructor.
54 * Resulting URL is not valid
60 * Delete an external texture if if protocolType is TEXTURE.
66 * Determines type of visual and whether the url is local or remote
67 * Notify that it is using an external texture if if protocolType is TEXTURE.
69 * @param[in] url The URL to store and resolve
71 VisualUrl(const std::string& url);
75 * @param[in] url The VisualUrl to copy
77 VisualUrl(const VisualUrl& url);
81 * @param[in] url The VisualUrl to copy
83 VisualUrl& operator=(const VisualUrl& url);
89 const std::string& GetUrl() const;
92 * Get the visual type of the URL
93 * @return The visual type of the URL
98 * Is the URL is local to the device, or remote?
99 * @return the location of the resource
101 ProtocolType GetProtocolType() const;
105 * @return true if the URL has length
107 bool IsValid() const;
110 * @return true if the location is LOCAL, i.e. is loadable from local file system
112 bool IsLocalResource() const;
115 * @return true if the location is BUFFER, i.e. may contain EncodedImageBuffer
117 bool IsBufferResource() const;
120 * @return the location part of the url
122 std::string GetLocation() const;
125 * Helper to create a URL of type TEXTURE
126 * @param location the location of the texture
129 static std::string CreateTextureUrl(const std::string& location);
132 * Helper to create a URL of type BUFFER
133 * @param location the location of the texture
136 static std::string CreateBufferUrl(const std::string& location);
139 * Helper to get a ProtocolType from url
140 * @param url the url of the texture
141 * @return the protocol type
143 static VisualUrl::ProtocolType GetProtocolType(const std::string& url);
146 * Helper to get a location from url
147 * @param url the location of the texture
148 * @return the location
150 static std::string GetLocation(const std::string& url);
155 ProtocolType mLocation;
158 } // namespace Internal
160 } // namespace Toolkit
164 #endif /* DALI_TOOLKIT_INTERNAL_VISUAL_URL_H */