dali-toolkit/internal/visuals/visual-url.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_VISUAL_URL_H
   2 #define DALI_TOOLKIT_INTERNAL_VISUAL_URL_H
   3
   4 /*
   5  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  */
  19
  20 #include <string>
  21
  22 namespace Dali
  23 {
  24
  25 namespace Toolkit
  26 {
  27
  28 namespace Internal
  29 {
  30
  31 class VisualUrl
  32 {
  33 public:
  34
  35   /**
  36    * The type of the URL based on the string contents
  37    */
  38   enum Type
  39   {
  40     REGULAR_IMAGE,
  41     N_PATCH,
  42     SVG,
  43     GIF
  44   };
  45
  46   enum ProtocolType
  47   {
  48     LOCAL,   ///< file in local file system
  49     TEXTURE, ///< texture uploaded to texture manager
  50     REMOTE   ///< remote image
  51   };
  52
  53   /**
  54    * Default Constructor.
  55    * Resulting URL is not valid
  56    */
  57   VisualUrl();
  58
  59   /**
  60    * Constructor.
  61    * Determines type of visual and whether the url is local or remote
  62    * @param[in] url The URL to store and resolve
  63    */
  64   VisualUrl( const std::string& url );
  65
  66   /**
  67    * Copy constructor
  68    * @param[in] url The VisualUrl to copy
  69    */
  70   VisualUrl( const VisualUrl& url );
  71
  72   /**
  73    * Assignment operator
  74    * @param[in] url The VisualUrl to copy
  75    */
  76   VisualUrl& operator=( const VisualUrl& url );
  77
  78   /**
  79    * Get the full URL
  80    * @return The url
  81    */
  82   const std::string& GetUrl() const;
  83
  84   /**
  85    * Get the visual type of the URL
  86    * @return The visual type of the URL
  87    */
  88   Type GetType() const;
  89
  90   /**
  91    * Is the URL is local to the device, or remote?
  92    * @return the location of the resource
  93    */
  94   ProtocolType GetProtocolType() const;
  95
  96   /**
  97    * Is the URL valid?
  98    * @return true if the URL has length
  99    */
 100   bool IsValid() const;
 101
 102   /**
 103    * @return true if the location is LOCAL, i.e. is loadable from local file system
 104    */
 105   bool IsLocalResource() const;
 106
 107   /**
 108    * @return the location part of the url
 109    */
 110   std::string GetLocation() const;
 111
 112   /**
 113    * Helper to create a URL of type TEXTURE
 114    * @param location the location of the texture
 115    * @return the Url
 116    */
 117   static std::string CreateTextureUrl( const std::string& location );
 118
 119 private:
 120   std::string mUrl;
 121   Type mType;
 122   ProtocolType mLocation;
 123 };
 124
 125
 126 } // namespace Internal
 127
 128 } // namespace Toolkit
 129
 130 } // namespace Dali
 131
 132 #endif /* DALI_TOOLKIT_INTERNAL_VISUAL_URL_H */