Wt::WCssTemplateRule Class Reference

A CSS rule based on a template widget. More...

#include <Wt/WCssStyleSheet.h>

Inheritance diagram for Wt::WCssTemplateRule:

Public Member Functions
	WCssTemplateRule (const std::string &selector)
	Creates a CSS rule with a given selector. More...
WWidget *	templateWidget ()
	Returns the widget that is used as a template. More...
virtual std::string	declarations () override
	Returns the declarations. More...
Public Member Functions inherited from Wt::WCssRule
virtual	~WCssRule ()
	Destructor.
void	setSelector (const std::string &selector)
	Sets the selector. More...
virtual std::string	selector () const
	Returns the selector.
WCssStyleSheet *	sheet () const
	Returns the style sheet to which this rule belongs.
void	modified ()
	Indicates that the rule has changed and needs updating.
Public Member Functions inherited from Wt::WObject
void	addChild (std::unique_ptr< WObject > child)
	Add a child WObject whose lifetime is determined by this WObject.
template<typename Child >
Child *	addChild (std::unique_ptr< Child > child)
	Add a child WObject, returning a raw pointer. More...
std::unique_ptr< WObject >	removeChild (WObject *child)
	Remove a child WObject, so its lifetime is no longer determined by this WObject.
virtual const std::string	id () const
	Returns the (unique) identifier for this object. More...
virtual void	setObjectName (const std::string &name)
	Sets an object name. 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...
Public Member Functions inherited from Wt::Core::observable
	observable ()
	Default constructor.
virtual	~observable ()
	Destructor. More...
template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...))
	Protects a method call against object destruction. More...
template<typename... Args, typename C >
auto	bindSafe (void(C::*method)(Args...) const) const
	Protects a const method call against object destruction. More...
template<typename Function >
auto	bindSafe (const Function &function)
	Protects a function against object destruction. More...

Additional Inherited Members
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
	Typedef for a WObject method without arguments.
Protected Member Functions inherited from Wt::WCssRule
	WCssRule (const std::string &selector)
	Creates a new CSS rule with given selector.
Protected Member Functions inherited from Wt::WObject
virtual WStatelessSlot *	getStateless (Method method)
	On-demand stateless slot implementation. More...

Detailed Description

A CSS rule based on a template widget.

This is a CSS rule whose CSS style properties are defined based on properties of a template widget. When modifying the template widget, these changes are reflected on the CSS rule and thus all widgets that have this CSS rule.

Usage example:

Wt::WCssTemplateRule *styleRule =
  Wt::WApplication::instance()->styleSheet().addRule(
    std::make_unique<Wt::WCssTemplateRule>("#" + id() + " .item"));

styleRule->templateWidget()->resize(100, WLength::Auto);
styleRule->templateWidget()->decorationStyle().setCursor(Cursor::PointingHand);

See also

Wt::WCssStyleSheet

Constructor & Destructor Documentation

Wt::WCssTemplateRule::WCssTemplateRule

(

const std::string &

selector

)

Creates a CSS rule with a given selector.

The selector should be a valid CSS selector.

Note

If you want to update the rule, then the selector should be unique and not contain commas, since this is not supported by Microsoft Internet Explorer.

Member Function Documentation

std::string Wt::WCssTemplateRule::declarations ( )

overridevirtual

Returns the declarations.

This is a semi-colon separated list of CSS declarations.

Implements Wt::WCssRule.

WWidget * Wt::WCssTemplateRule::templateWidget

(

)

Returns the widget that is used as a template.

Various properties of the widget are reflected in the CSS style:

• size and dimensions: WWidget::resize(), WWidget::setMinimumSize(), and WWidget::setMaximumSize()
• its position: WWidget::setPositionScheme(), WWidget::setOffsets(), WWidget::setFloatSide(), WWidget::setClearSides()
• visibility: WWidget::hide(), WWidget::show() and WWidget::setHidden()
• margins: WWidget::setMargin()
• line height: WWidget::setLineHeight()
• all decoration style properties: WWidget::decorationStyle()

When modifying one of these properties of the returned widget, the rule will be updated accordingly.