MQCheckBox class

(new in Rev4.00)

MQCheckBox class manages a check box. It inherits a MQWidgetBase class.

Please refer the inherited class about member functions declared in the inherited class.

Class
MQCheckBox Constructor
~MQCheckBox Destructor
Member functions
GetChecked Get a checked status
SetChecked Set a checked status
GetText Get a displayed string
SetText Set a displayed string
GetFontColor Get a font color
SetFontColor Set a font color
GetShadowText Get a shadow display
SetShadowText Set a shadow display
Events
AddChangedEvent Add an event for changing a checked status

MQCheckBox::MQCheckBox();

MQCheckBox::MQCheckBox(int id);

id
A widget ID created outside the plug-in

It is a constructor.


virtual MQCheckBox::~MQCheckBox();

This method is a destructor. It is defined as a virtual function.


bool MQCheckBox::GetChecked();

Return value
A checked status

It returns whether a check is on or off.


void MQCheckBox::SetChecked(bool value);

value
A checked status

It specifies whether a check is on or off.


std::wstring MQCheckBox::GetText();

Return value
A displayed string

It returns a string displayed beside a check box.


void MQCheckBox::SetText(const std::wstring& text);

text
A displayed string

It specifies a string displayed beside a check box.


void MQCheckBox::GetFontColor(int& r, int& g, int& b, int& a);

r
Red value
g
Green value
b
Blue value
a
Opacity

(new in Rev4.69)

It returns a color of a displayed font. Each value is from 0 to 255.

When a is 0, a text is drawn with a default color.


void MQCheckBox::SetFontColor(int r, int g, int b, int a);

r
Red value
g
Green value
b
Blue value
a
Opacity

(new in Rev4.69)

It specifies a color of a displayed font. Each value is from 0 to 255.


bool MQCheckBox::GetShadowText();

Return value
A shadow display

(new in Rev4.69)

It returns whether a shadow is displayed or not behide a text.


void MQCheckBox::SetShadowText(bool value);

value
A shadow display

(new in Rev4.69)

It specifies whether a shadow is displayed or not behide a text.


template<typename T> void MQCheckBox::AddChangedEvent(T *p, BOOL (T::*f)(MQWidgetBase*, MQDocument), bool prior = false)

p
A widget to notify events
f
A member function to notify events
prior
An order to notify events
[true] Notify first
[false] Notify last

It adds events notified when a checked status has been changed by user's operation.