Empirical
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
emp::web::internal::WidgetFacet< RETURN_TYPE > Class Template Reference

WidgetFacet is a template that provides accessors into Widget with a derived return type. More...

#include <Widget.h>

Inheritance diagram for emp::web::internal::WidgetFacet< RETURN_TYPE >:
emp::web::Widget

Public Types

using return_t = RETURN_TYPE
 

Public Member Functions

template<typename SETTING_TYPE >
return_tSetCSS (const std::string &setting, SETTING_TYPE &&value)
 Set a specific CSS value for this widget. More...
 
template<typename SETTING_TYPE >
return_tSetAttr (const std::string &setting, SETTING_TYPE &&value)
 Set a specific Attribute value for this widget. More...
 
template<typename T1 , typename T2 , typename... OTHER_SETTINGS>
return_tSetCSS (const std::string &setting1, T1 &&val1, const std::string &setting2, T2 &&val2, OTHER_SETTINGS...others)
 Multiple CSS settings can be provided simultaneously. More...
 
template<typename T1 , typename T2 , typename... OTHER_SETTINGS>
return_tSetAttr (const std::string &setting1, T1 &&val1, const std::string &setting2, T2 &&val2, OTHER_SETTINGS...others)
 Multiple Attributes can be provided simultaneously. More...
 
return_tSetCSS (const Style &in_style)
 
return_tSetAttr (const Attributes &in_attr)
 
return_tOn (const std::string &event_name, const std::function< void()> &fun)
 
return_tOn (const std::string &event_name, const std::function< void(MouseEvent evt)> &fun)
 
return_tOn (const std::string &event_name, const std::function< void(double, double)> &fun)
 
template<typename T >
return_tOnResize (T &&arg)
 Provide a function to be called when the window is resized. More...
 
template<typename T >
return_tOnClick (T &&arg)
 Provide a function to be called when the mouse button is clicked in this Widget. More...
 
template<typename T >
return_tOnDoubleClick (T &&arg)
 Provide a function to be called when the mouse button is double clicked in this Widget. More...
 
template<typename T >
return_tOnMouseDown (T &&arg)
 Provide a function to be called when the mouse button is pushed down in this Widget. More...
 
template<typename T >
return_tOnMouseUp (T &&arg)
 Provide a function to be called when the mouse button is released in this Widget. More...
 
template<typename T >
return_tOnMouseMove (T &&arg)
 Provide a function to be called whenever the mouse moves in this Widget. More...
 
template<typename T >
return_tOnMouseOut (T &&arg)
 Provide a function to be called whenever the mouse leaves the Widget. More...
 
template<typename T >
return_tOnMouseOver (T &&arg)
 Provide a function to be called whenever the mouse moves over the Widget. More...
 
template<typename T >
return_tOnMouseWheel (T &&arg)
 Provide a function to be called whenever the mouse wheel moves in this Widget. More...
 
template<typename T >
return_tOnKeydown (T &&arg)
 Provide a function to be called whenever a key is pressed down in this Widget. More...
 
template<typename T >
return_tOnKeypress (T &&arg)
 Provide a function to be called whenever a key is pressed down and released in this Widget. More...
 
template<typename T >
return_tOnKeyup (T &&arg)
 Provide a function to be called whenever a key is pressed released in this Widget. More...
 
template<typename T >
return_tOnCopy (T &&arg)
 Provide a function to be called whenever text is copied in this Widget. More...
 
template<typename T >
return_tOnCut (T &&arg)
 Provide a function to be called whenever text is cut in this Widget. More...
 
template<typename T >
return_tOnPaste (T &&arg)
 Provide a function to be called whenever text is pasted in this Widget. More...
 
return_tSetWidth (double w, const std::string &unit="px")
 
return_tSetHeight (double h, const std::string &unit="px")
 
return_tSetSize (double w, double h, const std::string &unit="px")
 
return_tCenter ()
 Move this widget to the center of its container. More...
 
return_tSetPosition (int x, int y, const std::string &unit="px", const std::string &pos_type="absolute", const std::string &x_anchor="left", const std::string &y_anchor="top")
 Set the x-y position of this widget within its container. More...
 
return_tSetPositionRT (int x, int y, const std::string &unit="px")
 Set the x-y position of this Widget within its container, using the TOP-RIGHT as an anchor. More...
 
return_tSetPositionRB (int x, int y, const std::string &unit="px")
 Set the x-y position of this Widget within its container, using the BOTTOM-RIGHT as an anchor. More...
 
return_tSetPositionLB (int x, int y, const std::string &unit="px")
 Set the x-y position of this Widget within its container, using the BOTTOM-LEFT as an anchor. More...
 
return_tSetPositionFixed (int x, int y, const std::string &unit="px")
 Set the x-y position of this Widget, fixed within the browser window. More...
 
return_tSetPositionFixedRT (int x, int y, const std::string &unit="px")
 Set the x-y position of the top-right corner this Widget, fixed within the browser window. More...
 
return_tSetPositionFixedRB (int x, int y, const std::string &unit="px")
 Set the x-y position of the bottom-right corner this Widget, fixed within the browser window. More...
 
return_tSetPositionFixedLB (int x, int y, const std::string &unit="px")
 Set the x-y position of the bottom-left corner this Widget, fixed within the browser window. More...
 
return_tSetFloat (const std::string &f="left")
 Set this Widget to float appropriately within its containter. More...
 
return_tSetOverflow (const std::string &o="auto")
 Setup how this Widget should handle overflow. More...
 
return_tSetScroll ()
 Setup how this Widget to always have scrollbars. More...
 
return_tSetScrollAuto ()
 Setup how this Widget to have scrollbars if needed for overflow. More...
 
return_tSetResizable ()
 Setup how this Widget to be user-resizable. More...
 
return_tSetResizableX ()
 Setup how this Widget for the x only to be user-resizable. More...
 
return_tSetResizableY ()
 Setup how this Widget for the y only to be user-resizable. More...
 
return_tSetResizableOff ()
 Setup how this Widget to NOT be resizable. More...
 
return_tSetFont (const Font &font)
 Provide a Font object to setup the font for this widget. More...
 
return_tSetFont (const std::string &font)
 Setup the Font to be used in this Widget. More...
 
return_tSetFontSize (int s)
 Setup the size of the Font to be used in this Widget. More...
 
return_tSetFontSizeVW (double s)
 Setup the size of the Font to be used in this Widget in units of % of viewport width. More...
 
return_tSetCenterText ()
 Align text to be centered. More...
 
return_tSetBackground (const std::string &v)
 Set the background color of this Widget. More...
 
return_tSetColor (const std::string &v)
 Set the foreground color of this Widget. More...
 
return_tSetOpacity (double v)
 Set the opacity level of this Widget. More...
 
return_tSetBorder (const std::string &border_info)
 Set information about the Widget board. More...
 
return_tSetPadding (double p, const std::string &unit="px")
 The the number of pixels (or alternate unit) for the padding around cells (used with Tables) More...
 
bool IsNull () const
 Test if this widget is valid. More...
 
std::string InfoTypeName () const
 Some debugging helpers... More...
 
bool IsInactive () const
 Test if the activity state of this widget is currently INACTIVE. More...
 
bool IsWaiting () const
 Test if the activity state of this widget is currently WAITING. More...
 
bool IsFrozen () const
 Test if the activity state of this widget is currently FROZEN. More...
 
bool IsActive () const
 Test if the activity state of this widget is currently ACTIVE. More...
 
bool AppendOK () const
 Is it okay to add more internal Widgets into this one? More...
 
void PreventAppend ()
 Disallow further appending to this Widget. More...
 
bool IsButton () const
 Is this Widget a Button? More...
 
bool IsCanvas () const
 Is this Widget a Canvas? More...
 
bool IsImage () const
 Is this Widget an Image? More...
 
bool IsSelector () const
 Is this Widget a Selector? More...
 
bool IsDiv () const
 Is this Widget a Div? More...
 
bool IsTable () const
 Is this Widget a Table? More...
 
bool IsText () const
 Is this Widget a Text? More...
 
const std::string & GetID () const
 What is the HTML string ID for this Widget? More...
 
virtual std::string GetCSS (const std::string &setting)
 
virtual bool HasCSS (const std::string &setting)
 Determine is a CSS trait has been set on this Widget. More...
 
virtual std::string GetAttr (const std::string &setting)
 Retrieve a specific attribute associated with this Widget. More...
 
virtual bool HasAttr (const std::string &setting)
 Determine is an attribute has been set on this Widget. More...
 
bool operator== (const Widget &in) const
 Are two Widgets refering to the same HTML object? More...
 
bool operator!= (const Widget &in) const
 Are two Widgets refering to differnt HTML objects? More...
 
 operator bool () const
 Conver Widget to bool (I.e., is this Widget active?) More...
 
double GetXPos ()
 Get the X-position of this Widget within its parent. More...
 
double GetYPos ()
 Get the Y-position of this Widget within its parent. More...
 
double GetWidth ()
 Get the width of this Widget on screen. More...
 
double GetHeight ()
 Get the height of this Widget on screen. More...
 
double GetInnerWidth ()
 Get the width of this Widget not including padding. More...
 
double GetInnerHeight ()
 Get the height of this Widget not including padding. More...
 
double GetOuterWidth ()
 Get the width of this Widget including all padding. More...
 
double GetOuterHeight ()
 Get the height of this Widget including all padding. More...
 
void Activate ()
 Make this widget live, so changes occur immediately (once document is ready) More...
 
void Freeze ()
 Record changes internally, but keep static screen until Activate() is called. More...
 
virtual void Deactivate (bool top_level=true)
 
bool ToggleActive ()
 Doggle between Active and Deactivated. More...
 
void Redraw ()
 Clear and redraw the current widget on the screen. More...
 
WidgetFind (const std::string &test_name)
 Look up previously created elements, by type. More...
 
WidgetAddDependant (const Widget &w)
 Add a dependant to this Widget that should be redrawn when it is. More...
 
virtual void PrepareAppend ()
 Setup << operator to redirect to Append; option preparation can be overridden. More...
 
template<typename IN_TYPE >
Widget operator<< (IN_TYPE &&in_val)
 
std::string GetInfoType () const
 Debug... More...
 

Protected Types

enum  ActivityState { INACTIVE, WAITING, FROZEN, ACTIVE }
 
using WidgetInfo = internal::WidgetInfo
 

Protected Member Functions

 WidgetFacet (const std::string &in_id="")
 WidgetFacet cannot be built unless within derived class, so constructors are protected. More...
 
 WidgetFacet (const WidgetFacet &in)
 
 WidgetFacet (const Widget &in)
 
 WidgetFacet (WidgetInfo *in_info)
 
WidgetFacetoperator= (const WidgetFacet &in)
 
virtual ~WidgetFacet ()
 
virtual void DoCSS (const std::string &setting, const std::string &value)
 
virtual void DoAttr (const std::string &setting, const std::string &value)
 
virtual void DoListen (const std::string &event_name, size_t fun_id)
 
template<typename FWD_TYPE >
WidgetForwardAppend (FWD_TYPE &&arg)
 If an Append doesn't work with current class, forward it to the parent and try there. More...
 
WidgetSetInfo (WidgetInfo *in_info)
 Set the information associated with this widget. More...
 
WidgetInfooperator-> ()
 Internally, we can treat a Widget as a pointer to its WidgetInfo. More...
 

Static Protected Member Functions

static WidgetInfoInfo (const Widget &w)
 Give derived classes the ability to access widget info. More...
 

Protected Attributes

WidgetInfoinfo
 Information associated with this widget. More...
 

Static Protected Attributes

static const std::string no_name = "(none)"
 Default name for un-initialized widgets. More...
 

Detailed Description

template<typename RETURN_TYPE>
class emp::web::internal::WidgetFacet< RETURN_TYPE >

WidgetFacet is a template that provides accessors into Widget with a derived return type.

Member Typedef Documentation

template<typename RETURN_TYPE>
using emp::web::internal::WidgetFacet< RETURN_TYPE >::return_t = RETURN_TYPE

Member Enumeration Documentation

enum emp::web::Widget::ActivityState
protectedinherited

Four activity states for any widget: INACTIVE - Not be in DOM at all. WAITING - Will become active once the page finishes loading. FROZEN - Part of DOM, but not updating on the screen. ACTIVE - Fully active; changes are reflected as they happen.

Enumerator
INACTIVE 
WAITING 
FROZEN 
ACTIVE 

Constructor & Destructor Documentation

template<typename RETURN_TYPE>
emp::web::internal::WidgetFacet< RETURN_TYPE >::WidgetFacet ( const std::string &  in_id = "")
inlineprotected

WidgetFacet cannot be built unless within derived class, so constructors are protected.

template<typename RETURN_TYPE>
emp::web::internal::WidgetFacet< RETURN_TYPE >::WidgetFacet ( const WidgetFacet< RETURN_TYPE > &  in)
inlineprotected
template<typename RETURN_TYPE>
emp::web::internal::WidgetFacet< RETURN_TYPE >::WidgetFacet ( const Widget in)
inlineprotected
template<typename RETURN_TYPE>
emp::web::internal::WidgetFacet< RETURN_TYPE >::WidgetFacet ( WidgetInfo in_info)
inlineprotected
template<typename RETURN_TYPE>
virtual emp::web::internal::WidgetFacet< RETURN_TYPE >::~WidgetFacet ( )
inlineprotectedvirtual

Member Function Documentation

void emp::web::Widget::Activate ( )
inherited

Make this widget live, so changes occur immediately (once document is ready)

Widget & emp::web::Widget::AddDependant ( const Widget w)
inherited

Add a dependant to this Widget that should be redrawn when it is.

bool emp::web::Widget::AppendOK ( ) const
inherited

Is it okay to add more internal Widgets into this one?

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::Center ( )
inline

Move this widget to the center of its container.

void emp::web::Widget::Deactivate ( bool  top_level = true)
virtualinherited

Record changes internally and REMOVE from screen until Activate is called. (Argument is for recursive, internal use only.)

Reimplemented in emp::web::Div.

template<typename RETURN_TYPE>
virtual void emp::web::internal::WidgetFacet< RETURN_TYPE >::DoAttr ( const std::string &  setting,
const std::string &  value 
)
inlineprotectedvirtual

Attr-related options may be overridden in derived classes that have multiple attributes. By default DoAttr will track the new information and apply it (if active) to the widget.

Reimplemented in emp::web::TableWidget, emp::web::TableCell, emp::web::TableCol, emp::web::TableColGroup, emp::web::TableRowGroup, and emp::web::TableRow.

template<typename RETURN_TYPE>
virtual void emp::web::internal::WidgetFacet< RETURN_TYPE >::DoCSS ( const std::string &  setting,
const std::string &  value 
)
inlineprotectedvirtual

CSS-related options may be overridden in derived classes that have multiple styles. By default DoCSS will track the new information and apply it (if active) to the widget.

Reimplemented in emp::web::TableWidget, emp::web::TableCell, emp::web::TableCol, emp::web::TableColGroup, emp::web::TableRow, and emp::web::TableRowGroup.

template<typename RETURN_TYPE>
virtual void emp::web::internal::WidgetFacet< RETURN_TYPE >::DoListen ( const std::string &  event_name,
size_t  fun_id 
)
inlineprotectedvirtual

Listener options may be overridden in derived classes that have multiple listen targets. By default DoListen will track new listens and set them up immediately, if active.

Reimplemented in emp::web::TableWidget, emp::web::TableCell, emp::web::TableCol, emp::web::TableColGroup, emp::web::TableRowGroup, and emp::web::TableRow.

Widget& emp::web::Widget::Find ( const std::string &  test_name)
inherited

Look up previously created elements, by type.

template<typename FWD_TYPE >
Widget& emp::web::Widget::ForwardAppend ( FWD_TYPE &&  arg)
protectedinherited

If an Append doesn't work with current class, forward it to the parent and try there.

void emp::web::Widget::Freeze ( )
inherited

Record changes internally, but keep static screen until Activate() is called.

std::string emp::web::Widget::GetAttr ( const std::string &  setting)
virtualinherited

Retrieve a specific attribute associated with this Widget.

std::string emp::web::Widget::GetCSS ( const std::string &  setting)
virtualinherited

Retrieve a specific CSS trait associated with this Widget. Note: CSS-related options may be overridden in derived classes that have multiple styles.

Reimplemented in emp::web::TableWidget, emp::web::TableCell, emp::web::TableCol, emp::web::TableColGroup, emp::web::TableRowGroup, and emp::web::TableRow.

double emp::web::Widget::GetHeight ( )
inherited

Get the height of this Widget on screen.

const std::string & emp::web::Widget::GetID ( ) const
inherited

What is the HTML string ID for this Widget?

std::string emp::web::Widget::GetInfoType ( ) const
inherited

Debug...

double emp::web::Widget::GetInnerHeight ( )
inherited

Get the height of this Widget not including padding.

double emp::web::Widget::GetInnerWidth ( )
inherited

Get the width of this Widget not including padding.

double emp::web::Widget::GetOuterHeight ( )
inherited

Get the height of this Widget including all padding.

double emp::web::Widget::GetOuterWidth ( )
inherited

Get the width of this Widget including all padding.

double emp::web::Widget::GetWidth ( )
inherited

Get the width of this Widget on screen.

double emp::web::Widget::GetXPos ( )
inherited

Get the X-position of this Widget within its parent.

double emp::web::Widget::GetYPos ( )
inherited

Get the Y-position of this Widget within its parent.

bool emp::web::Widget::HasAttr ( const std::string &  setting)
virtualinherited

Determine is an attribute has been set on this Widget.

bool emp::web::Widget::HasCSS ( const std::string &  setting)
virtualinherited

Determine is a CSS trait has been set on this Widget.

static WidgetInfo* emp::web::Widget::Info ( const Widget w)
inlinestaticprotectedinherited

Give derived classes the ability to access widget info.

std::string emp::web::Widget::InfoTypeName ( ) const
inherited

Some debugging helpers...

bool emp::web::Widget::IsActive ( ) const
inherited

Test if the activity state of this widget is currently ACTIVE.

bool emp::web::Widget::IsButton ( ) const
inherited

Is this Widget a Button?

bool emp::web::Widget::IsCanvas ( ) const
inherited

Is this Widget a Canvas?

bool emp::web::Widget::IsDiv ( ) const
inherited

Is this Widget a Div?

bool emp::web::Widget::IsFrozen ( ) const
inherited

Test if the activity state of this widget is currently FROZEN.

bool emp::web::Widget::IsImage ( ) const
inherited

Is this Widget an Image?

bool emp::web::Widget::IsInactive ( ) const
inherited

Test if the activity state of this widget is currently INACTIVE.

bool emp::web::Widget::IsNull ( ) const
inlineinherited

Test if this widget is valid.

bool emp::web::Widget::IsSelector ( ) const
inherited

Is this Widget a Selector?

bool emp::web::Widget::IsTable ( ) const
inherited

Is this Widget a Table?

bool emp::web::Widget::IsText ( ) const
inherited

Is this Widget a Text?

bool emp::web::Widget::IsWaiting ( ) const
inherited

Test if the activity state of this widget is currently WAITING.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::On ( const std::string &  event_name,
const std::function< void()> &  fun 
)
inline

Provide an event and a function that will be called when that event is triggered. In this case, the function as no arguments.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::On ( const std::string &  event_name,
const std::function< void(MouseEvent evt)> &  fun 
)
inline

Provide an event and a function that will be called when that event is triggered. In this case, the function takes a mouse event as an argument, with full info about mouse.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::On ( const std::string &  event_name,
const std::function< void(double, double)> &  fun 
)
inline

Provide an event and a function that will be called when that event is triggered. In this case, the function takes two doubles which will be filled in with mouse coordinates.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnClick ( T &&  arg)
inline

Provide a function to be called when the mouse button is clicked in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnCopy ( T &&  arg)
inline

Provide a function to be called whenever text is copied in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnCut ( T &&  arg)
inline

Provide a function to be called whenever text is cut in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnDoubleClick ( T &&  arg)
inline

Provide a function to be called when the mouse button is double clicked in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnKeydown ( T &&  arg)
inline

Provide a function to be called whenever a key is pressed down in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnKeypress ( T &&  arg)
inline

Provide a function to be called whenever a key is pressed down and released in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnKeyup ( T &&  arg)
inline

Provide a function to be called whenever a key is pressed released in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnMouseDown ( T &&  arg)
inline

Provide a function to be called when the mouse button is pushed down in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnMouseMove ( T &&  arg)
inline

Provide a function to be called whenever the mouse moves in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnMouseOut ( T &&  arg)
inline

Provide a function to be called whenever the mouse leaves the Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnMouseOver ( T &&  arg)
inline

Provide a function to be called whenever the mouse moves over the Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnMouseUp ( T &&  arg)
inline

Provide a function to be called when the mouse button is released in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnMouseWheel ( T &&  arg)
inline

Provide a function to be called whenever the mouse wheel moves in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnPaste ( T &&  arg)
inline

Provide a function to be called whenever text is pasted in this Widget.

template<typename RETURN_TYPE>
template<typename T >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::OnResize ( T &&  arg)
inline

Provide a function to be called when the window is resized.

emp::web::Widget::operator bool ( ) const
inlineinherited

Conver Widget to bool (I.e., is this Widget active?)

bool emp::web::Widget::operator!= ( const Widget in) const
inlineinherited

Are two Widgets refering to differnt HTML objects?

WidgetInfo* emp::web::Widget::operator-> ( )
inlineprotectedinherited

Internally, we can treat a Widget as a pointer to its WidgetInfo.

template<typename IN_TYPE >
Widget emp::web::Widget::operator<< ( IN_TYPE &&  in_val)
inherited
template<typename RETURN_TYPE>
WidgetFacet& emp::web::internal::WidgetFacet< RETURN_TYPE >::operator= ( const WidgetFacet< RETURN_TYPE > &  in)
inlineprotected
bool emp::web::Widget::operator== ( const Widget in) const
inlineinherited

Are two Widgets refering to the same HTML object?

virtual void emp::web::Widget::PrepareAppend ( )
inlinevirtualinherited

Setup << operator to redirect to Append; option preparation can be overridden.

Reimplemented in emp::web::TableWidget.

void emp::web::Widget::PreventAppend ( )
inherited

Disallow further appending to this Widget.

void emp::web::Widget::Redraw ( )
inherited

Clear and redraw the current widget on the screen.

template<typename RETURN_TYPE>
template<typename SETTING_TYPE >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetAttr ( const std::string &  setting,
SETTING_TYPE &&  value 
)
inline

Set a specific Attribute value for this widget.

template<typename RETURN_TYPE>
template<typename T1 , typename T2 , typename... OTHER_SETTINGS>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetAttr ( const std::string &  setting1,
T1 &&  val1,
const std::string &  setting2,
T2 &&  val2,
OTHER_SETTINGS...  others 
)
inline

Multiple Attributes can be provided simultaneously.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetAttr ( const Attributes in_attr)
inline

Allow multiple Attr settings to be provided as a single object. (still go through DoAttr given need for virtual re-routing.)

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetBackground ( const std::string &  v)
inline

Set the background color of this Widget.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetBorder ( const std::string &  border_info)
inline

Set information about the Widget board.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetCenterText ( )
inline

Align text to be centered.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetColor ( const std::string &  v)
inline

Set the foreground color of this Widget.

template<typename RETURN_TYPE>
template<typename SETTING_TYPE >
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetCSS ( const std::string &  setting,
SETTING_TYPE &&  value 
)
inline

Set a specific CSS value for this widget.

template<typename RETURN_TYPE>
template<typename T1 , typename T2 , typename... OTHER_SETTINGS>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetCSS ( const std::string &  setting1,
T1 &&  val1,
const std::string &  setting2,
T2 &&  val2,
OTHER_SETTINGS...  others 
)
inline

Multiple CSS settings can be provided simultaneously.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetCSS ( const Style in_style)
inline

Allow multiple CSS settings to be provided as a single object. (still go through DoCSS given need for virtual re-routing.)

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetFloat ( const std::string &  f = "left")
inline

Set this Widget to float appropriately within its containter.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetFont ( const Font font)
inline

Provide a Font object to setup the font for this widget.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetFont ( const std::string &  font)
inline

Setup the Font to be used in this Widget.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetFontSize ( int  s)
inline

Setup the size of the Font to be used in this Widget.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetFontSizeVW ( double  s)
inline

Setup the size of the Font to be used in this Widget in units of % of viewport width.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetHeight ( double  h,
const std::string &  unit = "px" 
)
inline

Update the height of this Widget.

Parameters
unitdefaults to pixels ("px"), but can also be a measured distance (e.g, "inches") or a percentage("%")
Widget & emp::web::Widget::SetInfo ( WidgetInfo in_info)
protectedinherited

Set the information associated with this widget.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetOpacity ( double  v)
inline

Set the opacity level of this Widget.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetOverflow ( const std::string &  o = "auto")
inline

Setup how this Widget should handle overflow.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetPadding ( double  p,
const std::string &  unit = "px" 
)
inline

The the number of pixels (or alternate unit) for the padding around cells (used with Tables)

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetPosition ( int  x,
int  y,
const std::string &  unit = "px",
const std::string &  pos_type = "absolute",
const std::string &  x_anchor = "left",
const std::string &  y_anchor = "top" 
)
inline

Set the x-y position of this widget within its container.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetPositionFixed ( int  x,
int  y,
const std::string &  unit = "px" 
)
inline

Set the x-y position of this Widget, fixed within the browser window.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetPositionFixedLB ( int  x,
int  y,
const std::string &  unit = "px" 
)
inline

Set the x-y position of the bottom-left corner this Widget, fixed within the browser window.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetPositionFixedRB ( int  x,
int  y,
const std::string &  unit = "px" 
)
inline

Set the x-y position of the bottom-right corner this Widget, fixed within the browser window.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetPositionFixedRT ( int  x,
int  y,
const std::string &  unit = "px" 
)
inline

Set the x-y position of the top-right corner this Widget, fixed within the browser window.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetPositionLB ( int  x,
int  y,
const std::string &  unit = "px" 
)
inline

Set the x-y position of this Widget within its container, using the BOTTOM-LEFT as an anchor.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetPositionRB ( int  x,
int  y,
const std::string &  unit = "px" 
)
inline

Set the x-y position of this Widget within its container, using the BOTTOM-RIGHT as an anchor.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetPositionRT ( int  x,
int  y,
const std::string &  unit = "px" 
)
inline

Set the x-y position of this Widget within its container, using the TOP-RIGHT as an anchor.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetResizable ( )
inline

Setup how this Widget to be user-resizable.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetResizableOff ( )
inline

Setup how this Widget to NOT be resizable.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetResizableX ( )
inline

Setup how this Widget for the x only to be user-resizable.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetResizableY ( )
inline

Setup how this Widget for the y only to be user-resizable.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetScroll ( )
inline

Setup how this Widget to always have scrollbars.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetScrollAuto ( )
inline

Setup how this Widget to have scrollbars if needed for overflow.

template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetSize ( double  w,
double  h,
const std::string &  unit = "px" 
)
inline

Update the size (width and height) of this widget.

Parameters
unitdefaults to pixels ("px"), but can also be a measured distance (e.g, "inches") or a percentage("%")
template<typename RETURN_TYPE>
return_t& emp::web::internal::WidgetFacet< RETURN_TYPE >::SetWidth ( double  w,
const std::string &  unit = "px" 
)
inline

Update the width of this Widget.

Parameters
unitdefaults to pixels ("px"), but can also be a measured distance (e.g, "inches") or a percentage("%")
bool emp::web::Widget::ToggleActive ( )
inherited

Doggle between Active and Deactivated.

Member Data Documentation

WidgetInfo* emp::web::Widget::info
protectedinherited

Information associated with this widget.

const std::string emp::web::Widget::no_name = "(none)"
staticprotectedinherited

Default name for un-initialized widgets.


The documentation for this class was generated from the following file: