NXWidgets: NXWidgets::CRadioButton Class Reference

NXWidgets 1.19

Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
NXWidgets::CRadioButton Class Reference

`#include <cradiobutton.hxx>`

Inheritance diagram for NXWidgets::CRadioButton:

## Public Types
enum | RadioButtonState { RADIO_BUTTON_STATE_OFF = 0, RADIO_BUTTON_STATE_ON = 1, RADIO_BUTTON_STATE_MU = 2 }
Public Types inherited from NXWidgets::CLabel
enum | TextAlignmentHoriz { TEXT_ALIGNMENT_HORIZ_CENTER = 0, TEXT_ALIGNMENT_HORIZ_LEFT = 1, TEXT_ALIGNMENT_HORIZ_RIGHT = 2 }
enum | TextAlignmentVert { TEXT_ALIGNMENT_VERT_CENTER = 0, TEXT_ALIGNMENT_VERT_TOP = 1, TEXT_ALIGNMENT_VERT_BOTTOM = 2 }
Public Types inherited from NXWidgets::CNxWidget
enum | WidgetFlagType { WIDGET_BORDERLESS = 0x0001, WIDGET_DRAGGABLE = 0x0002, WIDGET_PERMEABLE = 0x0004, WIDGET_DOUBLE_CLICKABLE = 0x0008, WIDGET_NO_RAISE_EVENTS = 0x0010 }

## Public Member Functions
| CRadioButton (CWidgetControl *pWidgetControl, nxgl_coord_t x, nxgl_coord_t y, nxgl_coord_t width, nxgl_coord_t height, CWidgetStyle *style=(CWidgetStyle *) NULL)
virtual RadioButtonState | getState (void)
virtual void | setState (RadioButtonState state)
Public Member Functions inherited from NXWidgets::CButton
| CButton (CWidgetControl *pWidgetControl, nxgl_coord_t x, nxgl_coord_t y, nxgl_coord_t width, nxgl_coord_t height, const CNxString &text, CWidgetStyle *style=(CWidgetStyle *) NULL)
virtual | ~CButton ()
Public Member Functions inherited from NXWidgets::CLabel
| CLabel (CWidgetControl *pWidgetControl, nxgl_coord_t x, nxgl_coord_t y, nxgl_coord_t width, nxgl_coord_t height, const CNxString &text, CWidgetStyle *style=(CWidgetStyle *) NULL)
virtual | ~CLabel ()
virtual void | setTextAlignmentHoriz (TextAlignmentHoriz alignment)
virtual void | setTextAlignmentVert (TextAlignmentVert alignment)
const TextAlignmentHoriz | getTextAlignmentHoriz (void) const
const TextAlignmentVert | getTextAlignmentVert (void) const
virtual const CNxString & | getText (void) const
virtual void | setText (const CNxString &text)
virtual void | appendText (const CNxString &text)
virtual void | insertText (const CNxString &text, const int index)
virtual void | highlight (bool highlightOn)
virtual bool | isHighlighted (void) const
virtual void | getPreferredDimensions (CRect &rect) const
virtual void | setFont (CNxFont *font)
virtual bool | isTextChange (void) const
Public Member Functions inherited from NXWidgets::CNxWidget
| CNxWidget (CWidgetControl *pWidgetControl, nxgl_coord_t x, nxgl_coord_t y, nxgl_coord_t width, nxgl_coord_t height, uint32_t flags, FAR const CWidgetStyle *style=(FAR const CWidgetStyle *) NULL)
virtual | ~CNxWidget (void)
nxgl_coord_t | getX (void) const
nxgl_coord_t | getY (void) const
nxgl_coord_t | getRelativeX (void) const
nxgl_coord_t | getRelativeY (void) const
bool | hasFocus (void) const
bool | isDeleted (void) const
bool | isDrawingEnabled (void) const
bool | isHidden (void) const
bool | isEnabled (void) const
bool | isPermeable (void) const
bool | isDoubleClickable (void) const
bool | isBorderless (void) const
bool | isClicked (void) const
bool | isBeingDragged (void) const
nxgl_coord_t | getWidth (void) const
nxgl_coord_t | getHeight (void) const
void | getSize (struct nxgl_size_s &size) const
void | getPos (struct nxgl_point_s &pos) const
CRect | getBoundingBox (void)
void | getBorderSize (WidgetBorderSize &borderSize)
CNxWidget * | getParent (void) const
CNxWidget * | getFocusedWidget (void)
void | getClientRect (CRect &rect) const
void | getRect (CRect &rect) const
CNxFont * | getFont (void) const
nxgl_mxpixel_t | getBackgroundColor (void) const
nxgl_mxpixel_t | getSelectedBackgroundColor (void) const
nxgl_mxpixel_t | getShineEdgeColor (void) const
nxgl_mxpixel_t | getShadowEdgeColor (void) const
nxgl_mxpixel_t | getHighlightColor (void) const
nxgl_mxpixel_t | getDisabledTextColor (void) const
nxgl_mxpixel_t | getEnabledTextColor (void) const
nxgl_mxpixel_t | getSelectedTextColor (void) const
const CWidgetStyle * | getWidgetStyle () const
void | setBorderless (bool isBorderless)
void | setDraggable (bool isDraggable)
void | setPermeable (bool permeable)
void | setDoubleClickable (bool doubleClickable)
void | addWidgetEventHandler (CWidgetEventHandler *eventHandler)
void | removeWidgetEventHandler (CWidgetEventHandler *eventHandler)
int | nWidgetEventHandlers (void) const
void | setRaisesEvents (bool raises)
bool | raisesEvents (void) const
void | disableDrawing (void)
void | enableDrawing (void)
void | setBackgroundColor (nxgl_mxpixel_t color)
void | setSelectedBackgroundColor (nxgl_mxpixel_t color)
void | setShineEdgeColor (nxgl_mxpixel_t color)
void | setShadowEdgeColor (nxgl_mxpixel_t color)
void | setHighlightColor (nxgl_mxpixel_t color)
void | setDisabledTextColor (nxgl_mxpixel_t color)
void | setEnabledTextColor (nxgl_mxpixel_t color)
void | setSelectedTextColor (nxgl_mxpixel_t color)
void | redraw (void)
bool | enable (void)
bool | disable (void)
void | close (void)
bool | show (void)
bool | hide (void)
virtual bool | click (nxgl_coord_t x, nxgl_coord_t y)
virtual bool | isDoubleClick (nxgl_coord_t x, nxgl_coord_t y)
bool | doubleClick (nxgl_coord_t x, nxgl_coord_t y)
bool | release (nxgl_coord_t x, nxgl_coord_t y)
bool | drag (nxgl_coord_t x, nxgl_coord_t y, nxgl_coord_t vX, nxgl_coord_t vY)
bool | keyPress (nxwidget_char_t key)
bool | cursorControl (ECursorControl control)
bool | focus (void)
bool | blur (void)
bool | moveTo (nxgl_coord_t x, nxgl_coord_t y)
bool | resize (nxgl_coord_t width, nxgl_coord_t height)
bool | changeDimensions (nxgl_coord_t x, nxgl_coord_t y, nxgl_coord_t width, nxgl_coord_t height)
void | moveChildToDeleteQueue (CNxWidget *widget)
void | setFocusedWidget (CNxWidget *widget)
virtual bool | checkCollision (nxgl_coord_t x, nxgl_coord_t y) const
virtual bool | checkCollision (nxgl_coord_t x, nxgl_coord_t y, nxgl_coord_t width, nxgl_coord_t height) const
bool | checkCollision (CNxWidget *widget) const
void | addWidget (CNxWidget *widget)
void | insertWidget (CNxWidget *widget)
void | setParent (CNxWidget *parent)
void | destroy (void)
bool | remove (void)
bool | removeChild (CNxWidget *widget)
const CNxWidget * | getChild (int index) const
int | getChildCount (void) const
void | setBorderSize (const WidgetBorderSize &borderSize)

## Protected Member Functions
virtual void | drawContents (CGraphicsPort *port)
virtual void | onClick (nxgl_coord_t x, nxgl_coord_t y)
virtual | ~CRadioButton ()
| CRadioButton (const CRadioButton &radioButton)
Protected Member Functions inherited from NXWidgets::CButton
virtual void | drawOutline (CGraphicsPort *port)
void | drawOutline (CGraphicsPort *port, bool useClicked)
void | drawContents (CGraphicsPort *port, bool useClicked)
virtual void | drawBorder (CGraphicsPort *port)
void | drawBorder (CGraphicsPort *port, bool useClicked)
virtual void | onPreRelease (nxgl_coord_t x, nxgl_coord_t y)
virtual void | onRelease (nxgl_coord_t x, nxgl_coord_t y)
virtual void | onReleaseOutside (nxgl_coord_t x, nxgl_coord_t y)
| CButton (const CButton &button)
Protected Member Functions inherited from NXWidgets::CLabel
virtual void | onResize (nxgl_coord_t width, nxgl_coord_t height)
virtual void | calculateTextPositionVertical (void)
virtual void | calculateTextPositionHorizontal (void)
virtual void | onTextChange (void)
| CLabel (const CLabel &label)
Protected Member Functions inherited from NXWidgets::CNxWidget
void | useWidgetStyle (const CWidgetStyle *style)
void | drawChildren (void)
void | closeChild (CNxWidget *widget)
void | startDragging (nxgl_coord_t x, nxgl_coord_t y)
void | stopDragging (nxgl_coord_t x, nxgl_coord_t y)
| CNxWidget (const CNxWidget &widget)
virtual void | onDoubleClick (nxgl_coord_t x, nxgl_coord_t y)
virtual void | onDrag (nxgl_coord_t x, nxgl_coord_t y, nxgl_coord_t vX, nxgl_coord_t vY)
virtual void | onDragStart (void)
virtual void | onDragStop (void)
virtual void | onFocus (void)
virtual void | onBlur (void)
virtual void | onEnable (void)
virtual void | onDisable (void)

## Protected Attributes
RadioButtonState | m_state
Protected Attributes inherited from NXWidgets::CLabel
CNxString | m_text
struct nxgl_point_s | m_align
TextAlignmentHoriz | m_hAlignment
TextAlignmentVert | m_vAlignment
bool | m_textChange
bool | m_highlighted
Protected Attributes inherited from NXWidgets::CNxWidget
CWidgetControl * | m_widgetControl
CRect | m_rect
nxgl_coord_t | m_grabPointX
nxgl_coord_t | m_grabPointY
nxgl_coord_t | m_newX
nxgl_coord_t | m_newY
CWidgetStyle | m_style
Flags | m_flags
CWidgetEventHandlerList * | m_widgetEventHandlers
struct timespec | m_lastClickTime
nxgl_coord_t | m_lastClickX
nxgl_coord_t | m_lastClickY
int | m_doubleClickBounds
CNxWidget * | m_parent
CNxWidget * | m_focusedChild
TNxArray< CNxWidget * > | m_children
WidgetBorderSize | m_borderSize

## Detailed Description

Represents a radio button. Radio buttons can only exist as part of a CRadioButtonGroup class, and should not be instantiated individually. Radio buttons are tri-state - off, on and "mu". The mu state cannot be enabled by a user - it can only be set by the developer.

Definition at line 111 of file cradiobutton.hxx.

## Member Enumeration Documentation

## ◆ RadioButtonState

enum NXWidgets::CRadioButton::RadioButtonState

Enum listing all possible radio button states.

Enumerator
RADIO_BUTTON_STATE_OFF | Radio button is off
RADIO_BUTTON_STATE_ON | Radio button is on
RADIO_BUTTON_STATE_MU | Radio button is in the third state

Definition at line 119 of file cradiobutton.hxx.

## Constructor & Destructor Documentation

## ◆ ~CRadioButton()

virtual NXWidgets::CRadioButton::~CRadioButton | ( |  | ) |
| inlineprotectedvirtual

Destructor.

Definition at line 153 of file cradiobutton.hxx.

## ◆ CRadioButton() [1/2]

NXWidgets::CRadioButton::CRadioButton | ( | const CRadioButton & | radioButton | ) |
| inlineprotected

Copy constructor is protected to prevent usage.

Definition at line 159 of file cradiobutton.hxx.

## ◆ CRadioButton() [2/2]

CRadioButton::CRadioButton | ( | CWidgetControl * | pWidgetControl,
|  | nxgl_coord_t | x,
|  | nxgl_coord_t | y,
|  | nxgl_coord_t | width,
|  | nxgl_coord_t | height,
|  | CWidgetStyle * | style = `(CWidgetStyle *)NULL`
| ) |  |

Constructor.

Parameters

  pWidgetControl | The controlling widget for the display.
  x | The x coordinate of the radio button, relative to its parent.
  y | The y coordinate of the radio button, relative to its parent.
  width | The width of the radio button.
  height | The height of the radio button.
  style | The style that the widget should use. If this is not specified, the widget will use the values stored in the global defaultCWidgetStyle object. The widget will copy the properties of the style into its own internal style object.

Definition at line 116 of file cradiobutton.cxx.

## Member Function Documentation

## ◆ drawContents()

void CRadioButton::drawContents | ( | CGraphicsPort * | port | ) |
| protectedvirtual

Draw the area of this widget that falls within the clipping region. Called by the redraw() function to draw all visible regions.

Parameters

  port | The CGraphicsPort to draw to.

See also
  redraw()

Reimplemented from NXWidgets::CButton.

Definition at line 156 of file cradiobutton.cxx.

## ◆ getState()

virtual RadioButtonState NXWidgets::CRadioButton::getState | ( | void |  | ) |
| inlinevirtual

Get the current state of the radio button.

Returns
  The state of the radio button.

Definition at line 190 of file cradiobutton.hxx.

## ◆ onClick()

void CRadioButton::onClick | ( | nxgl_coord_t | x,
|  | nxgl_coord_t | y
| ) |  |
| protectedvirtual

Sets the radiobutton's state to "on".

Parameters

  x | The x coordinate of the click.
  y | The y coordinate of the click.

Reimplemented from NXWidgets::CButton.

Definition at line 222 of file cradiobutton.cxx.

## ◆ setState()

void CRadioButton::setState | ( | CRadioButton::RadioButtonState | state | ) |
| virtual

Set the state of the radio button.

Parameters

  state | The new radio button state.

Definition at line 132 of file cradiobutton.cxx.

## Member Data Documentation

## ◆ m_state

RadioButtonState NXWidgets::CRadioButton::m_state
| protected

The state of the radio button

Definition at line 128 of file cradiobutton.hxx.

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

- cradiobutton.hxx
- cradiobutton.cxx