Wt  4.0.2
Public Types | Public Member Functions | List of all members
Wt::WLink Class Reference

A value class that defines a hyperlink target. More...

#include <WLink.h>

Public Types

typedef LinkType Type
 Typedef for enum Wt::LinkType.
 
typedef LinkTarget Target
 Typedef for enum Wt::LinkTarget.
 

Public Member Functions

 WLink ()
 Default constructor. More...
 
 WLink (const char *url)
 Creates a link to a (static) URL. More...
 
 WLink (const std::string &url)
 Creates a link to a (static) URL. More...
 
 WLink (LinkType type, const std::string &value)
 Creates a link to a (static) URL or an internal path. More...
 
 WLink (const std::shared_ptr< WResource > &resource)
 Creates a link to a resource. More...
 
LinkType type () const
 Returns the link type. More...
 
bool isNull () const
 Returns whether the link is unspecified. More...
 
void setUrl (const std::string &url)
 Sets the link URL. More...
 
std::string url () const
 Returns the link URL. More...
 
void setResource (const std::shared_ptr< WResource > &resource)
 Sets the link resource. More...
 
std::shared_ptr< WResourceresource () const
 Returns the link resource. More...
 
void setInternalPath (const WString &internalPath)
 Sets the link internal path. More...
 
WString internalPath () const
 Returns the internal path. More...
 
void setTarget (LinkTarget target)
 Sets the location where the linked content should be displayed. More...
 
LinkTarget target () const
 Returns the location where the linked content should be displayed. More...
 
bool operator== (const WLink &other) const
 Comparison operator.
 
bool operator!= (const WLink &other) const
 Comparison operator.
 

Detailed Description

A value class that defines a hyperlink target.

This class abstracts a link target. Depending on the context, it may reference a URL, a dynamic resource, or (for certain usages) an internal path.

See also
WAnchor, WImage, WMediaPlayer, WPopupMenuItem, WPushButton

Constructor & Destructor Documentation

Wt::WLink::WLink ( )

Default constructor.

This constructs a null link.

Wt::WLink::WLink ( const char *  url)

Creates a link to a (static) URL.

See also
setUrl()
Wt::WLink::WLink ( const std::string &  url)

Creates a link to a (static) URL.

See also
setUrl()
Wt::WLink::WLink ( LinkType  type,
const std::string &  value 
)

Creates a link to a (static) URL or an internal path.

Using this constructor, you can create a link to a static URL (type == LinkType::Url) or an internal path (type == LinkType::InternalPath). For an internal path, the value will be interpreted as a CharEncoding::UTF8 encoded string.

See also
setUrl(), setInternalPath()
Wt::WLink::WLink ( const std::shared_ptr< WResource > &  resource)

Creates a link to a resource.

See also
setResource()

Member Function Documentation

WString Wt::WLink::internalPath ( ) const

Returns the internal path.

This returns the internal path perviously set using setInternalPath(), or an empty string otherwise.

See also
setInternalPath().
bool Wt::WLink::isNull ( ) const

Returns whether the link is unspecified.

A null link is a link created using the default constructor and points to nowhere.

See also
WLink()
std::shared_ptr< WResource > Wt::WLink::resource ( ) const

Returns the link resource.

This returns the resource previously set using setResource(), or 0.

See also
setResource()
void Wt::WLink::setInternalPath ( const WString internalPath)

Sets the link internal path.

This points the link to the given internal path.

void Wt::WLink::setResource ( const std::shared_ptr< WResource > &  resource)

Sets the link resource.

This sets the type to LinkType::Resource.

void Wt::WLink::setTarget ( LinkTarget  target)

Sets the location where the linked content should be displayed.

By default, the linked content is displayed in the application (Wt::LinkTarget::Self). When the destination is an HTML document, the application is replaced with the new document. When the link is to a document that cannot be displayed in the browser, it is offered for download or opened using an external program, depending on browser settings.

By setting target to Wt::LinkTarget::NewWindow, the destination is displayed in a new browser window or tab.

See also
target()
void Wt::WLink::setUrl ( const std::string &  url)

Sets the link URL.

This sets the type to LinkType::Url.

LinkTarget Wt::WLink::target ( ) const

Returns the location where the linked content should be displayed.

See also
setTarget()
LinkType Wt::WLink::type ( ) const

Returns the link type.

The type is implicitly set depending on the constructor or after calling setUrl(), setResource() or setInternalPath().

The default type for a null link is LinkType::Url.

std::string Wt::WLink::url ( ) const

Returns the link URL.

The return value is the URL set by setUrl(), the resource URL of the resource set using setResource(), or the canonical URL of an internal path within the current application context.


Generated on Fri Nov 24 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11