NXWidgets: NXWidgets::CStickyImage Class Reference

NXWidgets 1.19

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

`#include <cstickyimage.hxx>`

Inheritance diagram for NXWidgets::CStickyImage:

## Public Member Functions
| CStickyImage (CWidgetControl *pWidgetControl, nxgl_coord_t x, nxgl_coord_t y, nxgl_coord_t width, nxgl_coord_t height, FAR IBitmap *bitmap, CWidgetStyle *style=(CWidgetStyle *) NULL)
virtual | ~CStickyImage (void)
void | setStuckSelection (bool selection)
void | toggleStuckSelection (void)
const bool | isStuckSelection (void) const
Public Member Functions inherited from NXWidgets::CImage
| CImage (CWidgetControl *pWidgetControl, nxgl_coord_t x, nxgl_coord_t y, nxgl_coord_t width, nxgl_coord_t height, FAR IBitmap *bitmap, CWidgetStyle *style=(CWidgetStyle *) NULL)
virtual | ~CImage ()
FAR IBitmap * | getBitmap () const
void | setBitmap (FAR IBitmap *bitmap)
void | getPreferredDimensions (CRect &rect) const
void | setImageLeft (nxgl_coord_t column)
void | alignHorizontalLeft (void)
void | alignHorizontalCenter (void)
void | alignHorizontalRight (void)
void | setImageTop (nxgl_coord_t row)
void | alignVerticalTop (void)
void | alignVerticalCenter (void)
void | alignVerticalBottom (void)
void | highlight (bool highlightOn)
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)
virtual void | setFont (CNxFont *font)
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 | drawBorder (CGraphicsPort *port)
virtual void | onClick (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)
| CStickyImage (const CStickyImage &image)
Protected Member Functions inherited from NXWidgets::CImage
void | drawContents (CGraphicsPort *port, bool selected)
void | drawBorder (CGraphicsPort *port, bool selected)
virtual void | onPreRelease (nxgl_coord_t x, nxgl_coord_t y)
| CImage (const CImage &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)
virtual void | onResize (nxgl_coord_t width, nxgl_coord_t height)

## Protected Attributes
bool | m_stuckSelection
Protected Attributes inherited from NXWidgets::CImage
FAR IBitmap * | m_bitmap
struct nxgl_point_s | m_origin
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

## Additional Inherited Members
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 }

## Detailed Description

CImage that sticks in the selected selected state when clicked.

Definition at line 71 of file cstickyimage.hxx.

## Constructor & Destructor Documentation

## ◆ CStickyImage() [1/2]

NXWidgets::CStickyImage::CStickyImage | ( | const CStickyImage & | image | ) |
| inlineprotected

Copy constructor is protected to prevent usage.

Definition at line 130 of file cstickyimage.hxx.

## ◆ CStickyImage() [2/2]

CStickyImage::CStickyImage | ( | CWidgetControl * | pWidgetControl,
|  | nxgl_coord_t | x,
|  | nxgl_coord_t | y,
|  | nxgl_coord_t | width,
|  | nxgl_coord_t | height,
|  | FAR IBitmap * | bitmap,
|  | CWidgetStyle * | style = `(CWidgetStyle *)NULL`
| ) |  |

Constructor for an image.

Parameters

  pWidgetControl | The controlling widget for the display
  x | The x coordinate of the image box, relative to its parent.
  y | The y coordinate of the image box, relative to its parent.
  width | The width of the image box.
  height | The height of the image box.
  bitmap | The source bitmap image.
  style | The style that the widget should use. If this is not specified, the image will use the global default widget style.

Definition at line 75 of file cstickyimage.cxx.

## ◆ ~CStickyImage()

virtual NXWidgets::CStickyImage::~CStickyImage | ( | void |  | ) |
| inlinevirtual

Destructor.

Definition at line 156 of file cstickyimage.hxx.

## Member Function Documentation

## ◆ drawBorder()

void CStickyImage::drawBorder | ( | 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::CImage.

Definition at line 117 of file cstickyimage.cxx.

## ◆ drawContents()

void CStickyImage::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::CImage.

Definition at line 104 of file cstickyimage.cxx.

## ◆ isStuckSelection()

const bool NXWidgets::CStickyImage::isStuckSelection | ( | void |  | ) | const
| inline

Returns the stuck selection state.

Returns
  True if the image is in the stuck selection state.

Definition at line 181 of file cstickyimage.hxx.

## ◆ onClick()

virtual void NXWidgets::CStickyImage::onClick | ( | nxgl_coord_t | x,
|  | nxgl_coord_t | y
| ) |  |
| inlineprotectedvirtual

Don't redraw on click events. The image state is completely controlled by the m_stuckSelection state.

Parameters

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

Reimplemented from NXWidgets::CImage.

Definition at line 104 of file cstickyimage.hxx.

## ◆ onRelease()

virtual void NXWidgets::CStickyImage::onRelease | ( | nxgl_coord_t | x,
|  | nxgl_coord_t | y
| ) |  |
| inlineprotectedvirtual

Don't redraw on release events. The image state is completely controlled by the m_stuckSelection state.

Parameters

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

Reimplemented from NXWidgets::CImage.

Definition at line 114 of file cstickyimage.hxx.

## ◆ onReleaseOutside()

virtual void NXWidgets::CStickyImage::onReleaseOutside | ( | nxgl_coord_t | x,
|  | nxgl_coord_t | y
| ) |  |
| inlineprotectedvirtual

Don't redraw on release events. The image state is completely controlled by the m_stuckSelection state.

Parameters

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

Reimplemented from NXWidgets::CImage.

Definition at line 124 of file cstickyimage.hxx.

## ◆ setStuckSelection()

void CStickyImage::setStuckSelection | ( | bool | selection | ) |

Sets the image's stuck selection state.

Parameters

  selection | The new stuck selection state.

Definition at line 90 of file cstickyimage.cxx.

## ◆ toggleStuckSelection()

void NXWidgets::CStickyImage::toggleStuckSelection | ( | void |  | ) |
| inline

Toggles the images stuck selection state.

Definition at line 170 of file cstickyimage.hxx.

## Member Data Documentation

## ◆ m_stuckSelection

bool NXWidgets::CStickyImage::m_stuckSelection
| protected

True if the image is stuck in the selected

Definition at line 74 of file cstickyimage.hxx.

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

- cstickyimage.hxx
- cstickyimage.cxx