inc/FWebCtrlHitElementResult.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file                FWebCtrlHitElementResult.h
  20  * @brief               This is the header file for the %HitElementResult class.
  21  *
  22  * This header file contains the declarations of the %HitElementResult class.
  23  */
  24 #ifndef _FWEB_CTRL_HIT_ELEMENT_RESULT_H_
  25 #define _FWEB_CTRL_HIT_ELEMENT_RESULT_H_
  26
  27 #include <FBaseColIMap.h>
  28 #include <FBaseObject.h>
  29 #include <FBaseString.h>
  30
  31 namespace Tizen { namespace Graphics
  32 {
  33 class Bitmap;
  34 }} // Tizen::Graphics
  35
  36 namespace Tizen { namespace Web { namespace Controls
  37 {
  38 class _HitElementResultImpl;
  39 }}} // Tizen::Web::Controls
  40
  41 namespace Tizen { namespace Web { namespace Controls
  42 {
  43
  44 /**
  45  * @class       HitElementResult
  46  * @brief               This class provides methods to retrieve information from the HyperText Markup Language (HTML) element, pointed by the x and y coordinates.
  47  *
  48  * @since       2.0
  49  *
  50  * The %HitElementResult class provides methods to retrieve information such as tag name, attributes and content from the HTML element.
  51  * @n
  52  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/controls_namespace.htm">Web Controls Guide</a>.
  53  *
  54  */
  55 class _OSP_EXPORT_ HitElementResult
  56         : public Tizen::Base::Object
  57 {
  58
  59 public:
  60         /**
  61          * This destructor overrides Tizen::Base::Object::~Object().
  62          *
  63          * @since               2.0
  64          */
  65         virtual ~HitElementResult(void);
  66
  67         /**
  68          * Gets the tag name of an element.
  69          *
  70          * @since               2.0
  71          *
  72          * @return              The tag name of the element
  73          */
  74         Tizen::Base::String GetTagName(void) const;
  75
  76         /**
  77          * Gets the value of the specified attribute.
  78          *
  79          * @since               2.0
  80          *
  81          * @return      The value of the specified attribute
  82          * @param[in]   attributeName                   The name of the attribute
  83          */
  84         Tizen::Base::String GetAttributeValue(const Tizen::Base::String& attributeName) const;
  85
  86         /**
  87          * Gets the content of an element.
  88          *
  89          * @since               2.0
  90          *
  91          * @return              The content of the element
  92          */
  93         Tizen::Base::String GetContent(void) const;
  94
  95         /**
  96         *  Gets the Uniform Resource Locator (URL) linked to the element.
  97         *
  98         * @since                2.0
  99         *
 100         * @return               The URL linked to the element
 101         */
 102         Tizen::Base::String GetUrl(void) const;
 103
 104         /**
 105          * Gets the image if the element is an image element.
 106          *
 107          * @since               2.0
 108          *
 109          * @return              The image
 110          */
 111         const Tizen::Graphics::Bitmap* GetImage(void) const;
 112
 113         /**
 114          * Checks whether the element is an image element.
 115          *
 116          * @since               2.0
 117          *
 118          * @return              @c true if the element is an image element, @n
 119          *                                      else @c false
 120          */
 121         bool HasImage(void) const;
 122
 123         /**
 124          * Checks whether the element has a URL linked to it.
 125          *
 126          * @since               2.0
 127          *
 128          * @return              @c true if there is a URL linked to the element, @n
 129          *                              else @c false
 130          */
 131         bool HasUrl(void) const;
 132
 133 private:
 134         //
 135         // This constructor is intentionally declared as private so that only the platform can create an instance.
 136         //
 137         // @remarks             This constructor is hidden.
 138         //
 139         HitElementResult(void);
 140
 141         //
 142         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 143         //
 144         // @param[in]   element The instance of the %HitElementResult class to copy from
 145         // @remarks             This constructor is hidden.
 146         //
 147         HitElementResult(const HitElementResult& element);
 148
 149         //
 150         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 151         //
 152         // @param[in]   source  The instance of the %HitElementResult class to assign from
 153         // @remarks             This operator is hidden.
 154         //
 155         HitElementResult& operator =(const HitElementResult& source);
 156
 157 private:
 158         _HitElementResultImpl* __pHitElementResultImpl;
 159
 160         friend class _HitElementResultImpl;
 161
 162         friend class _WebImpl;
 163 }; // HitElementResult
 164
 165 }}} // Tizen::Web::Controls
 166 #endif // _FWEB_CTRL_HIT_ELEMENT_RESULT_H_