2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 // Licensed under the Apache License, Version 2.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
8 // http://www.apache.org/licenses/LICENSE-2.0
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
18 * @file FBaseUtilLinkInfo.h
19 * @brief This is the header file for the %LinkInfo class.
21 * This header file contains the declarations of the %LinkInfo class.
23 #ifndef _FBASE_UTIL_LINK_INFO_H_
24 #define _FBASE_UTIL_LINK_INFO_H_
26 #include <FBaseColIList.h>
27 #include <FBaseString.h>
28 #include <FBaseUtilTypes.h>
31 namespace Tizen { namespace Base { namespace Utility
36 * @brief This class provides methods for accessing the link, its type, and a string that represents the link.
40 * The %LinkInfo class provides information regarding a link. It contains methods
41 * for accessing the link, its type, and a string that represents the link.
43 class _OSP_EXPORT_ LinkInfo
44 : public Tizen::Base::Object
48 * This is the default constructor for this class.
52 * @remarks The link and text are set to empty strings and the link type is set to @c LINK_TYPE_NONE.
57 * This destructor overrides Tizen::Base::Object::~Object().
61 virtual ~LinkInfo(void);
64 * Copying of objects using this copy constructor is allowed.
68 * @param[in] value An instance of %LinkInfo
70 LinkInfo(const LinkInfo& value);
73 * Initializes an instance of %LinkInfo with the specified parameters.
77 * @param[in] linkType The link type
78 * @param[in] link The link
79 * @remarks The link's @c text is set to the same string as @c link.
80 * @see Tizen::Base::Utility::LinkType
82 LinkInfo(LinkType linkType, const Tizen::Base::String& link);
85 * Initializes an instance of %LinkInfo with the specified parameters.
89 * @param[in] linkType The link type
90 * @param[in] link The link
91 * @param[in] text A string that represents the link
92 * @see Tizen::Base::Utility::LinkType
94 LinkInfo(LinkType linkType, const Tizen::Base::String& link, const Tizen::Base::String& text);
97 * Copying of objects using this copy assignment operator is allowed.
101 * @return A reference to the calling instance
102 * @param[in] rhs An instance of %LinkInfo
104 LinkInfo& operator =(const LinkInfo& rhs);
111 * @return The string that contains the link
114 Tizen::Base::String GetLink(void) const;
121 * @param[in] link The string that contains the link
124 void SetLink(const Tizen::Base::String& link);
127 * Gets the type of the link.
131 * @return The link type
133 * @see Tizen::Base::Utility::LinkType
135 LinkType GetLinkType(void) const;
138 * Sets the type of the link.
142 * @param[in] linkType The link type
144 * @see Tizen::Base::Utility::LinkType
146 void SetLinkType(LinkType linkType);
149 * Gets the string that represents the link.
153 * @return The string that represents the link
156 Tizen::Base::String GetText(void) const;
159 * Sets the string that represents the link.
163 * @return An error code
164 * @param[in] text The string that represents the link
167 void SetText(const Tizen::Base::String& text);
172 Tizen::Base::String __link;
173 Tizen::Base::String __text;
175 friend class _LinkInfoImpl;
176 class _LinkInfoImpl* __pLinkInfoImpl;
180 }}} // Tizen::Base::Utility
182 #endif // _FBASE_UTIL_LINK_INFO_H_