openMSX
Public Member Functions | Protected Member Functions | List of all members
openmsx::OSDWidget Class Referenceabstract

#include <OSDWidget.hh>

Inheritance diagram for openmsx::OSDWidget:
Inheritance graph
[legend]

Public Member Functions

virtual ~OSDWidget ()=default
 
std::string_view getName () const
 
gl::vec2 getPos () const
 
gl::vec2 getRelPos () const
 
float getZ () const
 
OSDWidget * getParent ()
 
const OSDWidget * getParent () const
 
const SubWidgets & getChildren () const
 
void addWidget (std::unique_ptr< OSDWidget > widget)
 
void deleteWidget (OSDWidget &widget)
 
virtual std::vector< std::string_view > getProperties () const
 
virtual void setProperty (Interpreter &interp, std::string_view name, const TclObject &value)
 
virtual void getProperty (std::string_view name, TclObject &result) const
 
virtual float getRecursiveFadeValue () const
 
virtual bool isRecursiveFading () const =0
 
virtual std::string_view getType () const =0
 
void invalidateRecursive ()
 
void paintSDLRecursive (OutputSurface &output)
 
void paintGLRecursive (OutputSurface &output)
 
int getScaleFactor (const OutputSurface &output) const
 
gl::vec2 transformPos (const OutputSurface &output, gl::vec2 pos, gl::vec2 relPos) const
 
void getBoundingBox (const OutputSurface &output, gl::vec2 &pos, gl::vec2 &size) const
 
virtual gl::vec2 getSize (const OutputSurface &output) const =0
 
virtual bool isVisible () const =0
 
Display & getDisplay () const
 

Protected Member Functions

 OSDWidget (Display &display, TclObject name)
 
void invalidateChildren ()
 
bool needSuppressErrors () const
 
virtual void invalidateLocal ()=0
 
virtual void paintSDL (OutputSurface &output)=0
 
virtual void paintGL (OutputSurface &output)=0
 

Detailed Description

Definition at line 16 of file OSDWidget.hh.

Constructor & Destructor Documentation

◆ ~OSDWidget()

virtual openmsx::OSDWidget::~OSDWidget ( )
virtualdefault

◆ OSDWidget()

openmsx::OSDWidget::OSDWidget ( Display &  display,
TclObject  name 
)
protected

Definition at line 142 of file OSDWidget.cc.

Member Function Documentation

◆ addWidget()

void openmsx::OSDWidget::addWidget ( std::unique_ptr< OSDWidget >  widget)

Definition at line 153 of file OSDWidget.cc.

References begin().

◆ deleteWidget()

void openmsx::OSDWidget::deleteWidget ( OSDWidget &  widget)

Definition at line 176 of file OSDWidget.cc.

References rfind_if_unguarded().

◆ getBoundingBox()

void openmsx::OSDWidget::getBoundingBox ( const OutputSurface &  output,
gl::vec2 &  pos,
gl::vec2 &  size 
) const

Definition at line 443 of file OSDWidget.cc.

References transformPos().

Referenced by paintGLRecursive(), and paintSDLRecursive().

◆ getChildren()

const SubWidgets& openmsx::OSDWidget::getChildren ( ) const
inline

Definition at line 29 of file OSDWidget.hh.

◆ getDisplay()

Display& openmsx::OSDWidget::getDisplay ( ) const
inline

Definition at line 55 of file OSDWidget.hh.

Referenced by openmsx::OSDImageBasedWidget::createImage(), openmsx::OSDImageBasedWidget::setError(), and openmsx::OSDTopWidget::showAllErrors().

◆ getName()

std::string_view openmsx::OSDWidget::getName ( ) const
inline

Definition at line 22 of file OSDWidget.hh.

References openmsx::TclObject::getString().

Referenced by openmsx::OSDTopWidget::addName(), and openmsx::OSDTopWidget::removeName().

◆ getParent() [1/2]

OSDWidget* openmsx::OSDWidget::getParent ( )
inline

Definition at line 27 of file OSDWidget.hh.

Referenced by openmsx::OSDImageBasedWidget::getRecursiveFadeValue(), getScaleFactor(), openmsx::OSDImageBasedWidget::isRecursiveFading(), needSuppressErrors(), setProperty(), and transformPos().

◆ getParent() [2/2]

const OSDWidget* openmsx::OSDWidget::getParent ( ) const
inline

Definition at line 28 of file OSDWidget.hh.

◆ getPos()

gl::vec2 openmsx::OSDWidget::getPos ( ) const
inline

Definition at line 23 of file OSDWidget.hh.

Referenced by transformPos().

◆ getProperties()

vector< string_view > openmsx::OSDWidget::getProperties ( ) const
virtual

Reimplemented in openmsx::OSDText, openmsx::OSDRectangle, and openmsx::OSDImageBasedWidget.

Definition at line 227 of file OSDWidget.cc.

Referenced by openmsx::OSDImageBasedWidget::getProperties().

◆ getProperty()

void openmsx::OSDWidget::getProperty ( std::string_view  name,
TclObject &  result 
) const
virtual

Reimplemented in openmsx::OSDText, openmsx::OSDRectangle, and openmsx::OSDImageBasedWidget.

Definition at line 280 of file OSDWidget.cc.

References openmsx::TclObject::addListElement(), getType(), and openmsx::x.

Referenced by openmsx::OSDImageBasedWidget::getProperty().

◆ getRecursiveFadeValue()

float openmsx::OSDWidget::getRecursiveFadeValue ( ) const
virtual

Reimplemented in openmsx::OSDImageBasedWidget.

Definition at line 308 of file OSDWidget.cc.

Referenced by openmsx::OSDImageBasedWidget::getRecursiveFadeValue().

◆ getRelPos()

gl::vec2 openmsx::OSDWidget::getRelPos ( ) const
inline

Definition at line 24 of file OSDWidget.hh.

Referenced by transformPos().

◆ getScaleFactor()

int openmsx::OSDWidget::getScaleFactor ( const OutputSurface &  output) const

Definition at line 370 of file OSDWidget.cc.

References openmsx::OutputSurface::getLogicalWidth(), getParent(), and getScaleFactor().

Referenced by getScaleFactor(), and transformPos().

◆ getSize()

virtual gl::vec2 openmsx::OSDWidget::getSize ( const OutputSurface &  output) const
pure virtual

Implemented in openmsx::OSDTopWidget.

Referenced by transformPos().

◆ getType()

virtual std::string_view openmsx::OSDWidget::getType ( ) const
pure virtual

Implemented in openmsx::OSDTopWidget, openmsx::OSDText, and openmsx::OSDRectangle.

Referenced by getProperty().

◆ getZ()

float openmsx::OSDWidget::getZ ( ) const
inline

Definition at line 25 of file OSDWidget.hh.

◆ invalidateChildren()

void openmsx::OSDWidget::invalidateChildren ( )
protected

Definition at line 319 of file OSDWidget.cc.

Referenced by invalidateRecursive(), and openmsx::OSDText::setProperty().

◆ invalidateLocal()

virtual void openmsx::OSDWidget::invalidateLocal ( )
protectedpure virtual

Implemented in openmsx::OSDTopWidget, and openmsx::OSDImageBasedWidget.

Referenced by invalidateRecursive().

◆ invalidateRecursive()

void openmsx::OSDWidget::invalidateRecursive ( )

Definition at line 313 of file OSDWidget.cc.

References invalidateChildren(), and invalidateLocal().

Referenced by setProperty(), openmsx::OSDRectangle::setProperty(), openmsx::OSDText::setProperty(), and openmsx::OSDGUILayer::~OSDGUILayer().

◆ isRecursiveFading()

virtual bool openmsx::OSDWidget::isRecursiveFading ( ) const
pure virtual

Implemented in openmsx::OSDTopWidget, and openmsx::OSDImageBasedWidget.

Referenced by openmsx::OSDImageBasedWidget::isRecursiveFading().

◆ isVisible()

virtual bool openmsx::OSDWidget::isVisible ( ) const
pure virtual

Implemented in openmsx::OSDTopWidget, and openmsx::OSDImageBasedWidget.

◆ needSuppressErrors()

bool openmsx::OSDWidget::needSuppressErrors ( ) const
protected

Definition at line 326 of file OSDWidget.cc.

References getParent().

Referenced by openmsx::OSDImageBasedWidget::setError().

◆ paintGL()

virtual void openmsx::OSDWidget::paintGL ( OutputSurface &  output)
protectedpure virtual

Implemented in openmsx::OSDTopWidget, and openmsx::OSDImageBasedWidget.

Referenced by paintGLRecursive().

◆ paintGLRecursive()

void openmsx::OSDWidget::paintGLRecursive ( OutputSurface &  output)

Definition at line 351 of file OSDWidget.cc.

References getBoundingBox(), paintGL(), and utf8::unchecked::size().

Referenced by openmsx::GLOSDGUILayer::paint().

◆ paintSDL()

virtual void openmsx::OSDWidget::paintSDL ( OutputSurface &  output)
protectedpure virtual

Implemented in openmsx::OSDTopWidget, and openmsx::OSDImageBasedWidget.

Referenced by paintSDLRecursive().

◆ paintSDLRecursive()

void openmsx::OSDWidget::paintSDLRecursive ( OutputSurface &  output)

Definition at line 335 of file OSDWidget.cc.

References getBoundingBox(), paintSDL(), and utf8::unchecked::size().

Referenced by openmsx::SDLOSDGUILayer::paint().

◆ setProperty()

void openmsx::OSDWidget::setProperty ( Interpreter &  interp,
std::string_view  name,
const TclObject &  value 
)
virtual

Reimplemented in openmsx::OSDText, openmsx::OSDRectangle, and openmsx::OSDImageBasedWidget.

Definition at line 236 of file OSDWidget.cc.

References openmsx::TclObject::getBoolean(), openmsx::TclObject::getDouble(), getParent(), and invalidateRecursive().

Referenced by openmsx::OSDImageBasedWidget::setProperty().

◆ transformPos()

vec2 openmsx::OSDWidget::transformPos ( const OutputSurface &  output,
gl::vec2  pos,
gl::vec2  relPos 
) const

Definition at line 381 of file OSDWidget.cc.

References getParent(), getPos(), getRelPos(), getScaleFactor(), and getSize().

Referenced by getBoundingBox().

The documentation for this class was generated from the following files:
Generated on Sun Jun 13 2021 11:04:09 for openMSX by doxygen 1.9.1