BitmapButtonStruct Class Reference

#include <customgui_bitmapbutton.h>

Inheritance diagram for BitmapButtonStruct:

Detailed Description

Bitmap button data type (CUSTOMDATATYPE_BITMAPBUTTON) for BitmapButtonCustomGui.

Note
Used to get a bitmap button in the Attribute Manager. Specify an object, op, that provides an icon through the MSG_DESCRIPTION_GETBITMAP message.

Public Member Functions

 BitmapButtonStruct ()
 
 BitmapButtonStruct (BaseList2D *t_op, const DescID &t_id, Int32 t_dirty)
 

Public Attributes

BaseList2Dop
 
DescID _id
 
Int32 dirty
 
Int32 reserved
 

Additional Inherited Members

- Static Public Attributes inherited from CustomDataTypeT< 1001053 >
static constexpr Int32 DATATYPEID
 

Constructor & Destructor Documentation

◆ BitmapButtonStruct() [1/2]

Default constructor.

◆ BitmapButtonStruct() [2/2]

BitmapButtonStruct ( BaseList2D t_op,
const DescID t_id,
Int32  t_dirty 
)

Creates a bitmap button data.

Parameters
[in]t_opThe object to send MSG_DESCRIPTION_GETBITMAP to.
[in]t_idThe ID for the DescriptionGetBitmap::id field.
[in]t_dirtyThe dirty flag. Internally used to detect changes. If this flag changes on parameter set, a new MSG_DESCRIPTION_GETBITMAP will be emitted.

Member Data Documentation

◆ op

The object to send MSG_DESCRIPTION_GETBITMAP to.

◆ _id

DescID _id

The ID for the DescriptionGetBitmap::id field.

◆ dirty

Int32 dirty

The dirty flag. Not used by the implementation. Use this to know when the image needs to be updated.

◆ reserved

Int32 reserved

Internal.