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.
81 LinkInfo(LinkType linkType, const Tizen::Base::String& link);
84 * Initializes an instance of %LinkInfo with the specified parameters.
88 * @param[in] linkType The link type
89 * @param[in] link The link
90 * @param[in] text The string that represents the link
92 LinkInfo(LinkType linkType, const Tizen::Base::String& link, const Tizen::Base::String& text);
95 * Copying of objects using this copy assignment operator is allowed.
99 * @return A reference to the calling instance
100 * @param[in] rhs An instance of %LinkInfo to copy
102 LinkInfo& operator =(const LinkInfo& rhs);
109 * @return The string that contains the link
112 Tizen::Base::String GetLink(void) const;
119 * @param[in] link The string that contains the link
122 void SetLink(const Tizen::Base::String& link);
125 * Gets the type of the link.
129 * @return The link type
132 LinkType GetLinkType(void) const;
135 * Sets the type of the link.
139 * @param[in] linkType The link type
142 void SetLinkType(LinkType linkType);
145 * Gets the string that represents the link.
149 * @return The string that represents the link
152 Tizen::Base::String GetText(void) const;
155 * Sets the string that represents the link.
159 * @return An error code
160 * @param[in] text The string that represents the link
163 void SetText(const Tizen::Base::String& text);
168 Tizen::Base::String __link;
169 Tizen::Base::String __text;
171 friend class _LinkInfoImpl;
172 class _LinkInfoImpl* __pLinkInfoImpl;
176 }}} // Tizen::Base::Utility
178 #endif // _FBASE_UTIL_LINK_INFO_H_