A widget that represents an HTML anchor (to link to other documents). More...

#include <Wt/WAnchor>

Inheritance diagram for Wt::WAnchor:

[legend]

Public Member Functions
	WAnchor (WContainerWidget *parent=0)
	Creates an anchor.

	WAnchor (const WLink &link, WContainerWidget *parent=0)
	Creates an anchor for the given link. More...

	WAnchor (const WLink &link, const WString &text, WContainerWidget *parent=0)
	Creates an anchor for the given link with a text. More...

	WAnchor (const WLink &link, WImage image, WContainerWidget parent=0)
	Creates an anchor for the given link with an image. More...

void	setLink (const WLink &link)
	Sets the link. More...

const WLink &	link () const
	Returns the link. More...

void	setRef (const std::string &url)
	Sets the linked URL (deprecated). More...

void	setRefInternalPath (const std::string &path)
	Sets a link to an internal path (deprecated). More...

std::string &	ref () const
	Returns the destination URL or internal path (deprecated). More...

void	setResource (WResource *resource)
	Sets a destination resource (deprecated). More...

WResource *	resource () const
	Returns the destination resource (deprecated). More...

void	setText (const WString &text)
	Sets the label text. More...

const WString &	text () const
	Returns the label text. More...

void	setWordWrap (bool wordWrap)
	Configures text word wrapping. More...

void	setTextFormat (TextFormat format)
	Configures the text format. More...

TextFormat	textFormat () const
	Returns the text format. More...

bool	wordWrap () const
	Returns whether the widget may break lines. More...

void	setImage (WImage *image)
	Sets an image. More...

WImage *	image () const
	Returns the image. More...

void	setTarget (AnchorTarget target)
	Sets the location where the linked content should be displayed. More...

AnchorTarget	target () const
	Returns the location where the linked content should be displayed. More...

virtual bool	canReceiveFocus () const
	Returns whether the widget can receive focus. More...

virtual int	tabIndex () const
	Returns the tab index. More...

virtual bool	setFirstFocus ()
	Set focus on the widget's first descendant. More...

Public Member Functions inherited from Wt::WContainerWidget
	WContainerWidget (WContainerWidget *parent=0)
	Creates a container with optional parent.

	~WContainerWidget ()
	Destructor.

void	setLayout (WLayout *layout)
	Sets a layout manager for the container. More...

void	setLayout (WLayout *layout, WFlags< AlignmentFlag > alignment)
	Sets a layout manager for the container (deprecated). More...

WLayout *	layout ()
	Returns the layout manager that was set for the container. More...

virtual void	addWidget (WWidget *widget)
	Adds a child widget to this container. More...

virtual void	insertBefore (WWidget widget, WWidget before)
	Inserts a child widget in this container, before another widget. More...

virtual void	insertWidget (int index, WWidget *widget)
	Inserts a child widget in this container at given index. More...

virtual void	removeWidget (WWidget *widget)
	Removes a child widget from this container. More...

virtual void	clear ()
	Removes and deletes all child widgets. More...

virtual int	indexOf (WWidget *widget) const
	Returns the index of a widget.

virtual WWidget *	widget (int index) const
	Returns the widget at index

virtual int	count () const
	Returns the number of widgets in this container.

void	setContentAlignment (WFlags< AlignmentFlag > contentAlignment)
	Specifies how child widgets must be aligned within the container. More...

void	setPadding (const WLength &padding, WFlags< Side > sides=All)
	Sets padding inside the widget. More...

WLength	padding (Side side) const
	Returns the padding set for the widget. More...

WFlags< AlignmentFlag >	contentAlignment () const
	Returns the alignment of children. More...

void	setOverflow (Overflow overflow, WFlags< Orientation > orientation=(Horizontal\|Vertical))
	Sets how overflow of contained children must be handled. More...

void	setList (bool list, bool ordered=false)
	Renders the container as an HTML list. More...

bool	isList () const
	Returns if this container is rendered as a List. More...

bool	isUnorderedList () const
	Returns if this container is rendered as an Unordered List. More...

bool	isOrderedList () const
	Returns if this container is rendered as an Ordered List. More...

EventSignal< WScrollEvent > &	scrolled ()
	Event signal emitted when scrolling in the widget. More...

int	scrollTop () const
	return the number of pixels the container is scrolled horizontally More...

int	scrollLeft () const
	return the number of pixels the container is scrolled vertically More...

Public Member Functions inherited from Wt::WInteractWidget
	WInteractWidget (WContainerWidget *parent=0)
	Create an InteractWidget with optional parent.

EventSignal< WKeyEvent > &	keyWentDown ()
	Event signal emitted when a keyboard key is pushed down. More...

EventSignal< WKeyEvent > &	keyPressed ()
	Event signal emitted when a "character" was entered. More...

EventSignal< WKeyEvent > &	keyWentUp ()
	Event signal emitted when a keyboard key is released. More...

EventSignal &	enterPressed ()
	Event signal emitted when enter was pressed. More...

EventSignal &	escapePressed ()
	Event signal emitted when escape was pressed. More...

EventSignal< WMouseEvent > &	clicked ()
	Event signal emitted when a mouse key was clicked on this widget. More...

EventSignal< WMouseEvent > &	doubleClicked ()
	Event signal emitted when a mouse key was double clicked on this widget. More...

EventSignal< WMouseEvent > &	mouseWentDown ()
	Event signal emitted when a mouse key was pushed down on this widget. More...

EventSignal< WMouseEvent > &	mouseWentUp ()
	Event signal emitted when a mouse key was released on this widget. More...

EventSignal< WMouseEvent > &	mouseWentOut ()
	Event signal emitted when the mouse went out of this widget. More...

EventSignal< WMouseEvent > &	mouseWentOver ()
	Event signal emitted when the mouse entered this widget. More...

EventSignal< WMouseEvent > &	mouseMoved ()
	Event signal emitted when the mouse moved over this widget. More...

EventSignal< WMouseEvent > &	mouseDragged ()
	Event signal emitted when the mouse is dragged over this widget. More...

EventSignal< WMouseEvent > &	mouseWheel ()
	Event signal emitted when the mouse scroll wheel was used. More...

EventSignal< WTouchEvent > &	touchStarted ()
	Event signal emitted when a finger is placed on the screen. More...

EventSignal< WTouchEvent > &	touchEnded ()
	Event signal emitted when a finger is removed from the screen. More...

EventSignal< WTouchEvent > &	touchMoved ()
	Event signal emitted when a finger, which is already placed on the screen, is moved across the screen. More...

EventSignal< WGestureEvent > &	gestureStarted ()
	Event signal emitted when a gesture is started. More...

EventSignal< WGestureEvent > &	gestureChanged ()
	Event signal emitted when a gesture is changed. More...

EventSignal< WGestureEvent > &	gestureEnded ()
	Event signal emitted when a gesture is ended. More...

void	setDraggable (const std::string &mimeType, WWidget dragWidget=0, bool isDragWidgetOnly=false, WObject sourceWidget=0)
	Configure dragging for drag and drop. More...

void	unsetDraggable ()
	Disable drag & drop for this widget. More...

void	setMouseOverDelay (int delay)
	Sets a delay for the mouse over event. More...

int	mouseOverDelay () const
	Returns the mouse over signal delay. More...

virtual void	setPopup (bool popup)
	Lets the widget overlay over other sibling widgets. More...

virtual void	load ()
	Loads content just before the widget is used. More...

virtual bool	isEnabled () const
	Returns whether the widget is enabled. More...

Public Member Functions inherited from Wt::WWebWidget
	WWebWidget (WContainerWidget *parent=0)
	Construct a WebWidget with a given parent. More...

virtual void	setPositionScheme (PositionScheme scheme)
	Sets the CSS position scheme. More...

virtual PositionScheme	positionScheme () const
	Returns the CSS position scheme. More...

virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=All)
	Sets CSS offsets for a non-statically positioned widget. More...

virtual WLength	offset (Side s) const
	Returns a CSS offset. More...

virtual void	resize (const WLength &width, const WLength &height)
	Resizes the widget. More...

virtual WLength	width () const
	Returns the width. More...

virtual WLength	height () const
	Returns the height. More...

virtual void	setMinimumSize (const WLength &width, const WLength &height)
	Sets a minimum size. More...

virtual WLength	minimumWidth () const
	Returns the minimum width. More...

virtual WLength	minimumHeight () const
	Returns the minimum height. More...

virtual void	setMaximumSize (const WLength &width, const WLength &height)
	Sets a maximum size. More...

virtual WLength	maximumWidth () const
	Returns the maximum width. More...

virtual WLength	maximumHeight () const
	Returns the maximum height. More...

virtual void	setLineHeight (const WLength &height)
	Sets the CSS line height for contained text.

virtual WLength	lineHeight () const
	Returns the CSS line height for contained text. More...

virtual void	setFloatSide (Side s)
	Specifies a CSS float side. More...

virtual Side	floatSide () const
	Returns the CSS float side. More...

virtual void	setClearSides (WFlags< Side > sides)
	Sets the sides that should be cleared of floats. More...

virtual WFlags< Side >	clearSides () const
	Returns the sides that should remain empty. More...

virtual void	setMargin (const WLength &margin, WFlags< Side > sides=All)
	Sets CSS margins around the widget. More...

virtual WLength	margin (Side side) const
	Returns a CSS margin set. More...

virtual void	setHiddenKeepsGeometry (bool enabled)
	Sets whether the widget keeps its geometry when hidden. More...

virtual bool	hiddenKeepsGeometry () const
	Returns whether the widget keeps its geometry when hidden. More...

virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation())
	Hides or shows the widget. More...

virtual bool	isHidden () const
	Returns whether the widget is set hidden. More...

virtual bool	isVisible () const
	Returns whether the widget is visible. More...

virtual void	setDisabled (bool disabled)
	Sets whether the widget is disabled. More...

virtual bool	isDisabled () const
	Returns whether the widget is set disabled. More...

virtual bool	isPopup () const
	Returns whether the widget is overlayed. More...

virtual void	setInline (bool isInline)
	Sets whether the widget is displayed inline or as a block. More...

virtual bool	isInline () const
	Returns whether the widget is displayed inline or as block. More...

virtual void	setDecorationStyle (const WCssDecorationStyle &style)
	Sets a CSS decoration style. More...

virtual WCssDecorationStyle &	decorationStyle ()
	Returns the decoration style of this widget. More...

virtual void	setStyleClass (const WString &styleClass)
	Sets (one or more) CSS style classes. More...

virtual WString	styleClass () const
	Returns the CSS style class. More...

virtual void	addStyleClass (const WString &styleClass, bool force=false)
	Adds a CSS style class. More...

virtual void	removeStyleClass (const WString &styleClass, bool force=false)
	Removes a CSS style class. More...

virtual bool	hasStyleClass (const WString &styleClass) const
	Returns whether the widget has a style class.

virtual void	setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength())
	Sets the vertical alignment. More...

virtual AlignmentFlag	verticalAlignment () const
	Returns the vertical alignment. More...

virtual WLength	verticalAlignmentLength () const
	Returns the fixed vertical alignment that was set. More...

virtual void	setToolTip (const WString &text, TextFormat textFormat=PlainText)
	Sets a tooltip. More...

virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
	Enable deferred tooltip. More...

virtual WString	toolTip () const
	Returns the tooltip.

virtual void	refresh ()
	Refresh the widget. More...

virtual void	setAttributeValue (const std::string &name, const WString &value)
	Sets an attribute value. More...

virtual WString	attributeValue (const std::string &name) const
	Returns an attribute value. More...

virtual void	setJavaScriptMember (const std::string &name, const std::string &value)
	Sets a JavaScript member. More...

virtual std::string	javaScriptMember (const std::string &name) const
	Returns the value of a JavaScript member. More...

virtual void	callJavaScriptMember (const std::string &name, const std::string &args)
	Calls a JavaScript member. More...

virtual bool	loaded () const
	Returns whether this widget has been loaded. More...

virtual void	setId (const std::string &id)
	Sets the CSS Id. More...

virtual WWidget *	find (const std::string &name)
	Finds a descendent widget by name. More...

virtual WWidget *	findById (const std::string &id)
	Finds a descendent widget by id.

virtual void	setSelectable (bool selectable)
	Sets as selectable. More...

virtual void	doJavaScript (const std::string &javascript)
	Executes the given JavaScript statements when the widget is rendered or updated. More...

virtual const std::string	id () const
	Returns the (unique) identifier for this object. More...

void	setLoadLaterWhenInvisible (bool)
	Change the way the widget is loaded when invisible. More...

std::string	htmlTagName () const
	returns the current html tag name More...

void	setHtmlTagName (const std::string &tag)
	set the custom HTML tag name More...

const std::vector< WWidget * > &	children () const
	Returns contained widgets. More...

Signal &	childrenChanged ()
	Signal emitted when children have been added or removed. More...

virtual void	setCanReceiveFocus (bool enabled)
	Sets whether the widget can receive focus. More...

virtual void	setFocus (bool focus)
	Sets focus. More...

virtual bool	hasFocus () const
	Returns whether the widget currently has the focus.

virtual void	setTabIndex (int index)
	Sets the tab index. More...

EventSignal &	blurred ()
	Signal emitted when the widget lost focus. More...

EventSignal &	focussed ()
	Signal emitted when the widget recieved focus. More...

virtual bool	scrollVisibilityEnabled () const WT_CXX11ONLY(finaloverride)
	Returns whether scroll visibility detection is enabled for this widget. More...

virtual void	setScrollVisibilityEnabled (bool enabled) WT_CXX11ONLY(finaloverride)
	Sets whether scroll visibility detection is enabled for this widget. More...

virtual int	scrollVisibilityMargin () const WT_CXX11ONLY(finaloverride)
	Returns the margin around the viewport within which the widget is considered visible. More...

virtual void	setScrollVisibilityMargin (int margin) WT_CXX11ONLY(finaloverride)
	Sets the margin around the viewport within which the widget is considered visible. More...

virtual Signal< bool > &	scrollVisibilityChanged () WT_CXX11ONLY(finaloverride)
	Signal triggered when the scroll visibility of this widget changes. More...

virtual bool	isScrollVisible () const WT_CXX11ONLY(finaloverride)
	Returns whether this widget is currently considered scroll visible. More...

virtual void	setThemeStyleEnabled (bool enabled)
	Sets whether theme styling for a widget is enabled or disabled. More...

virtual bool	isThemeStyleEnabled () const
	Returns whether this widget is currently styled by the chosen theme. More...

Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()
	Destructor. More...

WWidget *	parent () const
	Returns the parent widget. More...

virtual void	removeChild (WObject *child)
	Removes a child object. More...

void	setWidth (const WLength &width)
	Sets the width. More...

void	setHeight (const WLength &height)
	Sets the height. More...

virtual void	positionAt (const WWidget *widget, Orientation orientation=Vertical)
	Positions a widget next to another widget. More...

virtual void	toggleStyleClass (const WString &styleClass, bool add, bool force=false)
	Toggles a CSS style class.

std::string	jsRef () const
	Returns a JavaScript expression to the corresponding DOM node. More...

void	setFocus ()
	Sets focus. More...

virtual void	acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
	Sets a mime type to be accepted for dropping. More...

virtual void	stopAcceptDrops (const std::string &mimeType)
	Indicates that a mime type is no longer accepted for dropping. More...

virtual void	setObjectName (const std::string &name)
	Sets an object name. More...

virtual void	htmlText (std::ostream &out)
	Streams the (X)HTML representation. More...

bool	isRendered () const
	Returns whether the widget is rendered. More...

void	hide ()
	Hides the widget. More...

void	animateHide (const WAnimation &animation)
	Hides the widget using an animation. More...

void	show ()
	Shows the widget. More...

void	animateShow (const WAnimation &animation)
	Shows the widget using an animation. More...

void	enable ()
	Enables the widget. More...

void	disable ()
	Disable thes widget. More...

bool	layoutSizeAware () const
	Returns whether the widget is layout size aware. More...

Public Member Functions inherited from Wt::WObject
	WObject (WObject *parent=0)
	Create a WObject with a given parent object. More...

virtual	~WObject ()
	Destructor. More...

virtual std::string	objectName () const
	Returns the object name. More...

void	resetLearnedSlots ()
	Resets learned stateless slot implementations. More...

template<class T >
void	resetLearnedSlot (void(T::*method)())
	Resets a learned stateless slot implementation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::*method)())
	Declares a slot to be stateless and learn client-side behaviour on first invocation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::method)(), void(T::undoMethod)())
	Declares a slot to be stateless and learn client-side behaviour in advance. More...

void	isNotStateless ()
	Marks the current function as not stateless. More...

template<class T >
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
	Provides a JavaScript implementation for a method. More...

void	addChild (WObject *child)
	Adds a child object. More...

const std::vector< WObject * > &	children () const
	Returns the children.

WObject *	parent () const
	Returns the parent object.

Protected Member Functions
virtual void	propagateSetEnabled (bool enabled)
	Propagates that a widget was enabled or disabled through children. More...

virtual void	enableAjax ()
	Progresses to an Ajax-enabled widget. More...

Protected Member Functions inherited from Wt::WWebWidget
virtual WStatelessSlot *	getStateless (Method method)
	On-demand stateless slot implementation. More...

virtual void	render (WFlags< RenderFlag > flags)
	Renders the widget. More...

Protected Member Functions inherited from Wt::WWidget
void	setLayoutSizeAware (bool sizeAware)
	Sets the widget to be aware of its size set by a layout manager. More...

virtual void	layoutSizeChanged (int width, int height)
	Virtual method that indicates a size change. More...

	WWidget (WContainerWidget *parent=0)
	Creates a widget. More...

virtual void	dropEvent (WDropEvent dropEvent)
	Handles a drop event. More...

virtual int	boxPadding (Orientation orientation) const
	Returns the widget's built-in padding. More...

virtual int	boxBorder (Orientation orientation) const
	Returns the widget's built-in border width. More...

void	scheduleRender (WFlags< RepaintFlag > flags=0)
	Schedules rerendering of the widget. More...

Additional Inherited Members
Public Types inherited from Wt::WContainerWidget
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
	Typedef for a WObject method without arguments.

Static Public Member Functions inherited from Wt::WWebWidget
static WString	escapeText (const WString &text, bool newlinesToo=false)
	Escape HTML control characters in the text, to display literally (deprecated). More...

static std::string &	escapeText (std::string &text, bool newlinestoo=false)
	Escape HTML control characters in the text, to display literally (deprecated). More...

static bool	removeScript (WString &text)
	Remove tags/attributes from text that are not passive (deprecated). More...

static std::string	jsStringLiteral (const std::string &v, char delimiter= '\'')
	Turn a UTF8 encoded string into a JavaScript string literal. More...

Static Public Member Functions inherited from Wt::WWidget
static WString	tr (const char *key)
	Short hand for WString::tr() More...

Static Protected Member Functions inherited from Wt::WObject
static WObject *	sender ()
	Returns the sender of the current slot call. More...

Detailed Description

A widget that represents an HTML anchor (to link to other documents).

Use an anchor to link to another web page, document, internal application path or a resource (which specifies application-dependent content that may be generated by your application on demand). The anchor may contain a label text, an image, or any other widget (as it inherits from WContainerWidget). If you link to a document or external url, and do not want the application to terminate when the user follows the anchor, you must use setTarget(TargetNewWindow). Even for non-HTML documents, this may be important since pending Ajax requests are cancelled if documents are not served within the browser window in certain browsers.

When linking to a resource, the anchor does not assume ownership of resource, so that you may share the same resources for several anchors.

Usage example:

WAnchor *a;
// Create an anchor that links to a URL
a = new WAnchor("http://www.webtoolkit.eu/", "Wt web toolkit", this);
// Create an anchor that links to an internal path
a = new WAnchor(WLink(WLink::InternalPath, "/docs/" + myDocName()), "Doc", this);
//   and listen to the corresponding change in internal path
WApplication::instance()->internalPathChanged().connect(this, &DocsListWidget::onInternalPathChange);
// Create an anchor that links to a resource
WResource *r = new PdfResource(this); // serializes to a PDF file.
a = new WAnchor(r, "PDF version", this);
a->setTarget(TargetNewWindow);

WAnchor is an inline widget.

Note: If you set a text or image using one of the API methods like setText() or setImage() or a constructor, you should not attempt to remove all contents (using clear(), or provide a layout (using setLayout()), as this will result in undefined behaviour: the text or image are simply inserted as widgets into the container.

CSS

The widget corresponds to the HTML <a> tag and does not provide styling. It can be styled using inline or external CSS as appropriate.

Constructor & Destructor Documentation

Wt::WAnchor::WAnchor	(	const WLink &	link,
		WContainerWidget *	parent = `0`
	)

Creates an anchor for the given link.

The link may point to a URL, a dynamic resource, or an internal path.

See also: setLink()

Wt::WAnchor::WAnchor	(	const WLink &	link,
		const WString &	text,
		WContainerWidget *	parent = `0`
	)

Creates an anchor for the given link with a text.

The link may point to a URL, a dynamic resource, or an internal path.

See also: setLink(), setText()

Wt::WAnchor::WAnchor	(	const WLink &	link,
		WImage *	image,
		WContainerWidget *	parent = `0`
	)

Creates an anchor for the given link with an image.

Ownership of the image is transferred to the anchor.

See also: setLink(), setImage()

Member Function Documentation

bool Wt::WAnchor::canReceiveFocus ( ) const

virtual

Returns whether the widget can receive focus.

See also: setCanReceiveFocus()

Reimplemented from Wt::WWebWidget.

void Wt::WAnchor::enableAjax ( )

protectedvirtual

Progresses to an Ajax-enabled widget.

This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.

You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.

See also: WApplication::enableAjax()

Reimplemented from Wt::WWebWidget.

WImage* Wt::WAnchor::image ( ) const

Returns the image.

Returns 0 if no image is set.

See also: setImage()

const WLink& Wt::WAnchor::link ( ) const

Returns the link.

See also: setLink()

void Wt::WAnchor::propagateSetEnabled ( bool enabled )

protectedvirtual

Propagates that a widget was enabled or disabled through children.

When enabling or disabling a widget, you usually also want to disable contained children. This method is called by setDisabled() to propagate its state to all children.

You may want to reimplement this method if they wish to render differently when a widget is disabled. The default implementation will propagate the signal to all children.

Reimplemented from Wt::WInteractWidget.

std::string& Wt::WAnchor::ref ( ) const

Returns the destination URL or internal path (deprecated).

When the anchor links to a resource, the current resource URL is returned. When the anchor links to an internal path, the internal path is returned. Otherwise, the linked URL is returned.

Deprecated:: Use link() instead.

WResource * Wt::WAnchor::resource ( ) const

Returns the destination resource (deprecated).

Returns 0 if no resource has been set.

Deprecated:: Use link() instead.

bool Wt::WAnchor::setFirstFocus ( )

virtual

Set focus on the widget's first descendant.

Set focus on the widget itself, or on a first descendant which can receive focus.

Returns whether focus could be set.

Reimplemented from Wt::WWebWidget.

void Wt::WAnchor::setImage ( WImage * image )

Sets an image.

If an image was previously set, it is deleted. The image is added using addWidget().

Ownership of the image is transferred to the anchor.

void Wt::WAnchor::setLink ( const WLink & link )

Sets the link.

The link may hold a URL, a resource, or an internal path.

When the link points to a resource, the contents of the link may be generated by your application on demand.

When the link points to an internal path, activating the anchor will change the application's internal path or open a new session with the given path as initial path). This is the easiest way to let the application participate in browser history, and generate URLs that are bookmarkable and search engine friendly.

void Wt::WAnchor::setRef ( const std::string & url )

Sets the linked URL (deprecated).

Deprecated:: Use setLink() instead.

void Wt::WAnchor::setRefInternalPath ( const std::string & path )

Sets a link to an internal path (deprecated).

Note: the path should be UTF8 encoded (we may fix the API to use WString in the future).

Deprecated:: Use setLink() instead.

void Wt::WAnchor::setResource ( WResource * resource )

Sets a destination resource (deprecated).

The anchor does not assume ownership of the resource.

Deprecated:: Use setLink() instead.

void Wt::WAnchor::setTarget ( AnchorTarget target )

Sets the location where the linked content should be displayed.

By default, the linked content is displayed in the application (Wt::TargetSelf). 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::TargetNewWindow, the destination is displayed in a new browser window or tab.

See also: target()

void Wt::WAnchor::setText ( const WString & text )

Sets the label text.

If no text was previously set, a new WText widget is added using addWidget().

void Wt::WAnchor::setTextFormat ( TextFormat format )

Configures the text format.

The default text format is XHTMLText.

See also: WText::setTextFormat()

void Wt::WAnchor::setWordWrap ( bool wordWrap )

Configures text word wrapping.

When wordWrap is true, the text set with setText() may be broken up over multiple lines. When wordWrap is false, the text will displayed on a single line, unless the text contains <br /> tags or other block-level tags.

The default value is true.