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::Document Class Reference

#include <Document.h>

Inheritance diagram for emp::web::Document:
emp::web::Div emp::web::internal::WidgetFacet< Div > emp::web::Widget

Public Types

using INFO_TYPE = internal::DivInfo
 
using return_t = Div
 

Public Member Functions

 Document (const std::string &doc_id)
 
 ~Document ()
 
template<class... T>
web::Button AddButton (T &&...args)
 
template<class... T>
web::Canvas AddCanvas (T &&...args)
 
template<class... T>
web::FileInput AddFileInput (T &&...args)
 
template<class... T>
web::Image AddImage (T &&...args)
 
template<class... T>
web::Selector AddSelector (T &&...args)
 
template<class... T>
web::Div AddDiv (T &&...args)
 
template<class... T>
web::Table AddTable (T &&...args)
 
template<class... T>
web::Text AddText (T &&...args)
 
template<class... T>
web::TextArea AddTextArea (T &&...args)
 
web::Button Button (const std::string &in_id)
 
web::Canvas Canvas (const std::string &in_id)
 
web::FileInput FileInput (const std::string &in_id)
 
web::Image Image (const std::string &in_id)
 
web::Selector Selector (const std::string &in_id)
 
web::Div Div (const std::string &in_id)
 
web::Table Table (const std::string &in_id)
 
web::Text Text (const std::string &in_id)
 
web::TextArea TextArea (const std::string &in_id)
 
double ScrollTop () const
 Where is the top of the scroll region? More...
 
DivScrollTop (double in_top)
 Set the scroll position. More...
 
void Clear ()
 Clear the contents of this div. More...
 
void ClearChildren ()
 Remove all child widgets from this div. More...
 
bool HasChild (const Widget &test_child) const
 Determine if a specified widget is internal to this one. More...
 
void Deactivate (bool top_level) override
 Remove this widget from the current document. More...
 
WidgetFind (const std::string &test_name)
 Get an internal widget to this div, by the specified name. More...
 
emp::vector< Widget > & Children ()
 Get all direct child widgets to this div. More...
 
template<class... T>
web::AnimateAddAnimation (const std::string &name, T &&...args)
 Shortcut adder for animations. More...
 
web::AnimateAnimate (const std::string &in_id)
 
return_tSetCSS (const std::string &setting, SETTING_TYPE &&value)
 Set a specific CSS value for this widget. More...
 
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...
 
return_tSetCSS (const Style &in_style)
 
return_tSetAttr (const std::string &setting, SETTING_TYPE &&value)
 Set a specific Attribute value for this widget. More...
 
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_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)
 
return_tOnResize (T &&arg)
 Provide a function to be called when the window is resized. More...
 
return_tOnClick (T &&arg)
 Provide a function to be called when the mouse button is clicked in this Widget. More...
 
return_tOnDoubleClick (T &&arg)
 Provide a function to be called when the mouse button is double clicked in this Widget. More...
 
return_tOnMouseDown (T &&arg)
 Provide a function to be called when the mouse button is pushed down in this Widget. More...
 
return_tOnMouseUp (T &&arg)
 Provide a function to be called when the mouse button is released in this Widget. More...
 
return_tOnMouseMove (T &&arg)
 Provide a function to be called whenever the mouse moves in this Widget. More...
 
return_tOnMouseOut (T &&arg)
 Provide a function to be called whenever the mouse leaves the Widget. More...
 
return_tOnMouseOver (T &&arg)
 Provide a function to be called whenever the mouse moves over the Widget. More...
 
return_tOnMouseWheel (T &&arg)
 Provide a function to be called whenever the mouse wheel moves in this Widget. More...
 
return_tOnKeydown (T &&arg)
 Provide a function to be called whenever a key is pressed down in this Widget. More...
 
return_tOnKeypress (T &&arg)
 Provide a function to be called whenever a key is pressed down and released in this Widget. More...
 
return_tOnKeyup (T &&arg)
 Provide a function to be called whenever a key is pressed released in this Widget. More...
 
return_tOnCopy (T &&arg)
 Provide a function to be called whenever text is copied in this Widget. More...
 
return_tOnCut (T &&arg)
 Provide a function to be called whenever text is cut in this Widget. More...
 
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...
 
bool ToggleActive ()
 Doggle between Active and Deactivated. More...
 
void Redraw ()
 Clear and redraw the current widget on the screen. 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

internal::DivInfoInfo ()
 
const internal::DivInfoInfo () const
 
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...
 

Member Typedef Documentation

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

emp::web::Document::Document ( const std::string &  doc_id)
inline
emp::web::Document::~Document ( )
inline

Member Function Documentation

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

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

template<class... T>
web::Animate& emp::web::Div::AddAnimation ( const std::string &  name,
T &&...  args 
)
inlineinherited

Shortcut adder for animations.

template<class... T>
web::Button emp::web::Document::AddButton ( T &&...  args)
inline
template<class... T>
web::Canvas emp::web::Document::AddCanvas ( T &&...  args)
inline
Widget & emp::web::Widget::AddDependant ( const Widget w)
inherited

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

template<class... T>
web::Div emp::web::Document::AddDiv ( T &&...  args)
inline
template<class... T>
web::FileInput emp::web::Document::AddFileInput ( T &&...  args)
inline
template<class... T>
web::Image emp::web::Document::AddImage ( T &&...  args)
inline
template<class... T>
web::Selector emp::web::Document::AddSelector ( T &&...  args)
inline
template<class... T>
web::Table emp::web::Document::AddTable ( T &&...  args)
inline
template<class... T>
web::Text emp::web::Document::AddText ( T &&...  args)
inline
template<class... T>
web::TextArea emp::web::Document::AddTextArea ( T &&...  args)
inline
web::Animate& emp::web::Div::Animate ( const std::string &  in_id)
inlineinherited
bool emp::web::Widget::AppendOK ( ) const
inherited

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

web::Button emp::web::Document::Button ( const std::string &  in_id)
inline
web::Canvas emp::web::Document::Canvas ( const std::string &  in_id)
inline
return_t& emp::web::internal::WidgetFacet< Div >::Center ( )
inlineinherited

Move this widget to the center of its container.

emp::vector<Widget>& emp::web::Div::Children ( )
inlineinherited

Get all direct child widgets to this div.

void emp::web::Div::Clear ( )
inlineinherited

Clear the contents of this div.

void emp::web::Div::ClearChildren ( )
inlineinherited

Remove all child widgets from this div.

void emp::web::Div::Deactivate ( bool  top_level)
inlineoverridevirtualinherited

Remove this widget from the current document.

Reimplemented from emp::web::Widget.

web::Div emp::web::Document::Div ( const std::string &  in_id)
inline
virtual void emp::web::internal::WidgetFacet< Div >::DoAttr ( const std::string &  setting,
const std::string &  value 
)
inlineprotectedvirtualinherited

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.

virtual void emp::web::internal::WidgetFacet< Div >::DoCSS ( const std::string &  setting,
const std::string &  value 
)
inlineprotectedvirtualinherited

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.

virtual void emp::web::internal::WidgetFacet< Div >::DoListen ( const std::string &  event_name,
size_t  fun_id 
)
inlineprotectedvirtualinherited

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.

web::FileInput emp::web::Document::FileInput ( const std::string &  in_id)
inline
Widget& emp::web::Div::Find ( const std::string &  test_name)
inlineinherited

Get an internal widget to this div, by the specified name.

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::Div::HasChild ( const Widget test_child) const
inlineinherited

Determine if a specified widget is internal to this one.

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

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

web::Image emp::web::Document::Image ( const std::string &  in_id)
inline
static WidgetInfo* emp::web::Widget::Info ( const Widget w)
inlinestaticprotectedinherited

Give derived classes the ability to access widget info.

internal::DivInfo* emp::web::Div::Info ( )
inlineprotectedinherited
const internal::DivInfo* emp::web::Div::Info ( ) const
inlineprotectedinherited
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.

return_t& emp::web::internal::WidgetFacet< Div >::On ( const std::string &  event_name,
const std::function< void()> &  fun 
)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::On ( const std::string &  event_name,
const std::function< void(MouseEvent evt)> &  fun 
)
inlineinherited

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.

return_t& emp::web::internal::WidgetFacet< Div >::On ( const std::string &  event_name,
const std::function< void(double, double)> &  fun 
)
inlineinherited

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.

return_t& emp::web::internal::WidgetFacet< Div >::OnClick ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnCopy ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnCut ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnDoubleClick ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnKeydown ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnKeypress ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnKeyup ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnMouseDown ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnMouseMove ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnMouseOut ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnMouseOver ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnMouseUp ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnMouseWheel ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnPaste ( T &&  arg)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::OnResize ( T &&  arg)
inlineinherited

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
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.

double emp::web::Div::ScrollTop ( ) const
inlineinherited

Where is the top of the scroll region?

Div& emp::web::Div::ScrollTop ( double  in_top)
inlineinherited

Set the scroll position.

web::Selector emp::web::Document::Selector ( const std::string &  in_id)
inline
return_t& emp::web::internal::WidgetFacet< Div >::SetAttr ( const std::string &  setting,
SETTING_TYPE &&  value 
)
inlineinherited

Set a specific Attribute value for this widget.

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

Multiple Attributes can be provided simultaneously.

return_t& emp::web::internal::WidgetFacet< Div >::SetAttr ( const Attributes in_attr)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetBackground ( const std::string &  v)
inlineinherited

Set the background color of this Widget.

return_t& emp::web::internal::WidgetFacet< Div >::SetBorder ( const std::string &  border_info)
inlineinherited

Set information about the Widget board.

return_t& emp::web::internal::WidgetFacet< Div >::SetCenterText ( )
inlineinherited

Align text to be centered.

return_t& emp::web::internal::WidgetFacet< Div >::SetColor ( const std::string &  v)
inlineinherited

Set the foreground color of this Widget.

return_t& emp::web::internal::WidgetFacet< Div >::SetCSS ( const std::string &  setting,
SETTING_TYPE &&  value 
)
inlineinherited

Set a specific CSS value for this widget.

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

Multiple CSS settings can be provided simultaneously.

return_t& emp::web::internal::WidgetFacet< Div >::SetCSS ( const Style in_style)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetFloat ( const std::string &  f = "left")
inlineinherited

Set this Widget to float appropriately within its containter.

return_t& emp::web::internal::WidgetFacet< Div >::SetFont ( const Font font)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetFont ( const std::string &  font)
inlineinherited

Setup the Font to be used in this Widget.

return_t& emp::web::internal::WidgetFacet< Div >::SetFontSize ( int  s)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetFontSizeVW ( double  s)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetHeight ( double  h,
const std::string &  unit = "px" 
)
inlineinherited

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.

return_t& emp::web::internal::WidgetFacet< Div >::SetOpacity ( double  v)
inlineinherited

Set the opacity level of this Widget.

return_t& emp::web::internal::WidgetFacet< Div >::SetOverflow ( const std::string &  o = "auto")
inlineinherited

Setup how this Widget should handle overflow.

return_t& emp::web::internal::WidgetFacet< Div >::SetPadding ( double  p,
const std::string &  unit = "px" 
)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::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" 
)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetPositionFixed ( int  x,
int  y,
const std::string &  unit = "px" 
)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetPositionFixedLB ( int  x,
int  y,
const std::string &  unit = "px" 
)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetPositionFixedRB ( int  x,
int  y,
const std::string &  unit = "px" 
)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetPositionFixedRT ( int  x,
int  y,
const std::string &  unit = "px" 
)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetPositionLB ( int  x,
int  y,
const std::string &  unit = "px" 
)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetPositionRB ( int  x,
int  y,
const std::string &  unit = "px" 
)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetPositionRT ( int  x,
int  y,
const std::string &  unit = "px" 
)
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetResizable ( )
inlineinherited

Setup how this Widget to be user-resizable.

return_t& emp::web::internal::WidgetFacet< Div >::SetResizableOff ( )
inlineinherited

Setup how this Widget to NOT be resizable.

return_t& emp::web::internal::WidgetFacet< Div >::SetResizableX ( )
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetResizableY ( )
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetScroll ( )
inlineinherited

Setup how this Widget to always have scrollbars.

return_t& emp::web::internal::WidgetFacet< Div >::SetScrollAuto ( )
inlineinherited

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

return_t& emp::web::internal::WidgetFacet< Div >::SetSize ( double  w,
double  h,
const std::string &  unit = "px" 
)
inlineinherited

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("%")
return_t& emp::web::internal::WidgetFacet< Div >::SetWidth ( double  w,
const std::string &  unit = "px" 
)
inlineinherited

Update the width of this Widget.

Parameters
unitdefaults to pixels ("px"), but can also be a measured distance (e.g, "inches") or a percentage("%")
web::Table emp::web::Document::Table ( const std::string &  in_id)
inline
web::Text emp::web::Document::Text ( const std::string &  in_id)
inline
web::TextArea emp::web::Document::TextArea ( const std::string &  in_id)
inline
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: