MFMv2.0.10
Movable Feast Machine Simulator 2.0.10
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions
MFM::AbstractCheckboxExternal Class Reference

#include <AbstractCheckbox.h>

Inheritance diagram for MFM::AbstractCheckboxExternal:
MFM::AbstractCheckbox MFM::AbstractButton MFM::Panel MFM::AbstractGUIDriver< GC >::AbstractGridCheckbox MFM::AbstractGUIDriver< GC >::BGRButton MFM::AbstractGUIDriver< GC >::GridRenderButton MFM::AbstractGUIDriver< GC >::GridRunCheckbox MFM::AbstractGUIDriver< GC >::HeatmapButton

Public Member Functions

 AbstractCheckboxExternal (const char *title)
 
void SetExternalValue (bool *ptr)
 
virtual bool IsChecked () const
 
virtual void SetChecked (bool checked)
 
- Public Member Functions inherited from MFM::AbstractCheckbox
 AbstractCheckbox ()
 
 AbstractCheckbox (const char *text)
 
virtual void PaintBorder (Drawing &d)
 
virtual void PaintComponent (Drawing &d)
 
virtual void OnClick (u8 button)
 
virtual void OnCheck (bool value)=0
 
- Public Member Functions inherited from MFM::AbstractButton
 AbstractButton ()
 
 AbstractButton (const char *text)
 
 AbstractButton (SDL_Surface *icon)
 
 AbstractButton (const char *text, SDL_Surface *icon)
 
 ~AbstractButton ()
 
void SetLocation (const SPoint &location)
 
void SetIcon (SDL_Surface *icon)
 
SDL_Surface * GetIcon ()
 
void SetDimensions (const SPoint &dimensions)
 
void SetEnabled (bool isEnabled)
 
void SetText (const char *text)
 
const char * GetText ()
 
bool IsEnabled () const
 
bool Contains (SPoint &pt)
 
virtual bool Handle (MouseButtonEvent &event)
 
virtual void HandleResize (const UPoint &parentSize)
 
bool PaintClickHighlight (Drawing &d)
 
virtual void PaintComponentNonClick (Drawing &d)
 
virtual void OnPress (u8 button)
 
- Public Member Functions inherited from MFM::Panel
 Panel (u32 width=0, u32 height=0)
 
void Insert (Panel *child, Panel *afterOrNull)
 
PanelPop ()
 
void Remove (Panel *child)
 
void SetVisibility (bool value)
 
void ToggleVisibility ()
 
bool IsVisible ()
 
u32 GetWidth () const
 
u32 GetHeight () const
 
void SetDimensions (u32 width, u32 height)
 
void SetDesiredSize (u32 width, u32 height)
 
const UPointGetDimensions () const
 
const UPointGetDesiredSize () const
 
void SetRenderPoint (const SPoint &renderPt)
 
const SPointGetRenderPoint () const
 
const char * GetName () const
 
void SetName (const char *name)
 
void Print (ByteSink &sink, u32 indent=0) const
 
u32 GetBackground () const
 
u32 SetBackground (const u32 color)
 
u32 GetBorder () const
 
u32 SetBorder (const u32 color)
 
u32 GetForeground () const
 
u32 SetForeground (const u32 color)
 
TTF_Font * GetFont () const
 
TTF_Font * SetFont (TTF_Font *newFont)
 
SPoint GetAbsoluteLocation ()
 
virtual void Paint (Drawing &config)
 
virtual void PaintUpdateVisibility (Drawing &config)
 
virtual void PaintChildren (Drawing &config)
 
virtual bool Dispatch (MouseEvent &event, const Rect &rect)
 
virtual bool Handle (MouseMotionEvent &event)
 
virtual void OnMouseExit ()
 
void SetAnchor (const GUIAnchor anchor)
 
SPoint GetTextSize (TTF_Font *font, const char *text)
 

Additional Inherited Members

- Static Protected Member Functions inherited from MFM::Panel
static void Indent (ByteSink &sink, u32 count)
 
- Protected Attributes inherited from MFM::Panel
OString16 m_name
 
Rect m_rect
 
u32 m_bdColor
 
u32 m_bgColor
 
u32 m_fgColor
 
TTF_Font * m_font
 
UPoint m_desiredSize
 
SPoint m_desiredLocation
 
Panelm_parent
 
Panelm_top
 
Panelm_forward
 
Panelm_backward
 
Panelm_focusedChild
 
bool m_visible
 

Detailed Description

A subclass of an AbstractCheckbox in which an extern bool * is used to implement the boolean value.

Member Function Documentation

virtual bool MFM::AbstractCheckboxExternal::IsChecked ( ) const
inlinevirtual

Checks to see if this AbstractCheckbox is in its on state. If it is in its on state, its backing boolean value (if it exists) is guaranteed to be true. If it is not, or does not have a backing boolean value, this will be false .

Returns
true if the boolean value backed by this AbstractCheckbox is set and is equal to , else false.

Implements MFM::AbstractCheckbox.

virtual void MFM::AbstractCheckboxExternal::SetChecked ( bool  checked)
inlinevirtual

Sets the value of the boolean backing this AbstractCheckbox . If there is no boolean bacing this AbstractCheckbox , this FAILs with NULL_POINTER .

Parameters
checkedThe new value to set the boolean value backing this AbstractCheckbox to.

Implements MFM::AbstractCheckbox.

void MFM::AbstractCheckboxExternal::SetExternalValue ( bool *  ptr)
inline

Sets the pointer to the boolean value which is backing this AbstractCheckbox . It is important to set this before using this AbstractCheckbox .

Parameters
externalValueThe pointer to the boolean value wished to back this AbstractCheckbox . Any modifications to the state of this AbstractCheckbox will also modify the contents of this pointer .

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