Wt  3.7.1
Public Types | Public Member Functions | List of all members
Wt::WCssDecorationStyle Class Reference

A style class for a single widget or style sheet rule. More...

#include <Wt/WCssDecorationStyle>

Public Types

enum  Repeat { RepeatXY, RepeatX, RepeatY, NoRepeat }
 How a background image must be repeated. More...
enum  TextDecoration { Underline = 0x1, Overline = 0x2, LineThrough = 0x4, Blink = 0x8 }
 Text decoration options. More...

Public Member Functions

 WCssDecorationStyle ()
 Creates a default style.
 WCssDecorationStyle (const WCssDecorationStyle &other)
 Copy constructor.
 ~WCssDecorationStyle ()
WCssDecorationStyleoperator= (const WCssDecorationStyle &other)
 Assignment operator.
void setCursor (Cursor c)
 Sets the cursor style.
Cursor cursor () const
 Returns the cursor style. More...
void setCursor (std::string cursorImage, Cursor fallback=ArrowCursor)
 Sets a custom cursor image Url. More...
std::string cursorImage () const
 Returns the cursor image. More...
void setBackgroundColor (WColor color)
 Sets the background color.
WColor backgroundColor () const
 Returns the background color. More...
void setBackgroundImage (const WLink &link, Repeat repeat=RepeatXY, WFlags< Side > sides=0)
 Sets a background image. More...
std::string backgroundImage () const
 Returns the background image URL. More...
Repeat backgroundImageRepeat () const
 Returns the background image repeat. More...
void setForegroundColor (WColor color)
 Sets the text color.
WColor foregroundColor () const
 Returns the text color. More...
void setBorder (WBorder border, WFlags< Side > sides=All)
 Sets the border style. More...
WBorder border (Side side=Top) const
 Returns the border style. More...
void setFont (const WFont &font)
 Sets the text font.
WFontfont ()
 Returns the font. More...
void setTextDecoration (WFlags< TextDecoration > decoration)
 Sets text decoration options. More...
WFlags< TextDecorationtextDecoration () const
 Returns the text decoration options. More...

Detailed Description

A style class for a single widget or style sheet rule.

You can manipulate the decoration style of a single widget using WWidget::decorationStyle() or you can use a WCssDecorationStyle to add a rule to the inline style sheet using WCssStyleSheet::addRule(const std::string&, const WCssDecorationStyle& style, const std::string&).

Usage example:

Wt::WWidget *widget = ...

Member Enumeration Documentation

◆ Repeat

How a background image must be repeated.


Repeat horizontally and vertically, default.


Repeat horizontally.


Repeat vertically.


Do not repeat.

◆ TextDecoration

Text decoration options.









Member Function Documentation

◆ backgroundColor()

WColor Wt::WCssDecorationStyle::backgroundColor ( ) const

Returns the background color.

See also

◆ backgroundImage()

std::string Wt::WCssDecorationStyle::backgroundImage ( ) const

Returns the background image URL.

See also

◆ backgroundImageRepeat()

Repeat Wt::WCssDecorationStyle::backgroundImageRepeat ( ) const

Returns the background image repeat.

See also

◆ border()

WBorder WCssDecorationStyle::border ( Side  side = Top) const

Returns the border style.

Returns the border style set using setBorder() for the given side.

See also
Prior to version 3.1.9 it was not possible to pass a side and only one border could be configured.

◆ cursor()

Cursor Wt::WCssDecorationStyle::cursor ( ) const

Returns the cursor style.

See also

◆ cursorImage()

std::string Wt::WCssDecorationStyle::cursorImage ( ) const

Returns the cursor image.

See also

◆ font()

WFont& Wt::WCssDecorationStyle::font ( )

Returns the font.

See also

◆ foregroundColor()

WColor Wt::WCssDecorationStyle::foregroundColor ( ) const

Returns the text color.

See also

◆ setBackgroundImage()

void WCssDecorationStyle::setBackgroundImage ( const WLink link,
Repeat  repeat = RepeatXY,
WFlags< Side sides = 0 

Sets a background image.

The link may be a URL or a resource.

The image may be placed in a particular location by specifying sides by OR'ing Wt::Side values together, e.g. (Right | Top).

◆ setBorder()

void WCssDecorationStyle::setBorder ( WBorder  border,
WFlags< Side sides = All 

Sets the border style.

The given border will be set for the specified sides.

A different border style may be specified for each of the four sides.

◆ setCursor()

void WCssDecorationStyle::setCursor ( std::string  cursorImage,
Cursor  fallback = ArrowCursor 

Sets a custom cursor image Url.

The Url should point to a .cur file (this shoul be a real .cur file, renaming an .ico is not enough for Internet Explorer).

◆ setTextDecoration()

void WCssDecorationStyle::setTextDecoration ( WFlags< TextDecoration decoration)

Sets text decoration options.

You may logically or together any of the options of the TextDecoration enumeration.

The default is 0.

◆ textDecoration()

WFlags<TextDecoration> Wt::WCssDecorationStyle::textDecoration ( ) const

Returns the text decoration options.

See also

Generated on Tue Dec 15 2020 for the C++ Web Toolkit (Wt) by doxygen 1.8.13