MQListBox class

(new in Rev4.00)

MQListBox class manages a list box. It inherits a MQWidgetBase class

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

Class
MQListBox Constructor
~MQListBox Destructor
Member functions
GetCurrentIndex Get a current index
SetCurrentIndex Set a current index
AddItem Add an item
DeleteItem Delete an item
ClearItems Clear all items
GetItemCount Get a number of items
GetItem Get a text in an item
SetItem Set a text in an item
GetItemTag Get an arbitrary value in an item
SetItemTag Set an arbitrary value in an item
GetItemSelected Get a selection status of an item
SetItemSelected Set a selection status of an item
GetItemHint Get a hint string of an item
SetItemHint Set a hint string of an item
GetVisibleRow Get a number of visible rows
SetVisibleRow Set a number of visible rows
GetLineHeightRate Get a rate of a line height
SetLineHeightRate Set a rate of a line height
GetVertScrollVisible Get a visibility of a vertical scroll bar
SetVertScrollVisible Set a visibility of a vertical scroll bar
GetMultiSelect Get a multi selection
SetMultiSelect Set a multi selection
ClearSelection Clear all selections
MakeItemVisible Show an item in the visible area
Events
AddChangedEvent Add an event when a current index or a selection has been changed.
AddDrawItemEvent Add an event when an item is drawn.

MQListBox::MQListBox();

MQListBox::MQListBox(int id);

id
A widget ID created outside the plug-in

It is a constructor.


virtual MQListBox::~MQListBox();

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


int MQListBox::GetCurrentIndex();

Return value
A current index

It returns an index of an active item.


void MQListBox::SetCurrentIndex(int value);

value
A current index

It specifies an index of an active item.


int MQListBox::AddItem(const std::wstring& text);

int MQListBox::AddItem(const std::wstring& text, __int64 tag);

text
A string for an adding item
tag
An arbitrary value
Return value
An index of the added item

It adds a new item.

An item has a displayed string and an arbitrary value.


void MQListBox::DeleteItem(int index);

index
An index of a deleting item

It deletes a specified index of an item.

Indices of items behind the deleted item will be moved up one by one.


void MQListBox::ClearItems();

It deletes all items.


int MQListBox::GetItemCount();

Return value
A number of items

It returns a number of items in the list.


std::wstring MQListBox::GetItem(int index);

index
An index of an item
Return value
A string

It returns a string of the specified item.


void MQListBox::SetItem(int index, const std::wstring& text);

index
An index of an item
text
A string

It sets a string of the specified item.


__int64 MQListBox::GetItemTag(int index);

index
An index of an item
Return value
An arbitrary value

It returns an arbitrary value assigned to the specified item.


void MQListBox::SetItemTag(int index, __int64 tag);

index
An index of an item
tag
An arbitrary value

It assigns an arbitrary value to the specified item.


bool MQListBox::GetItemSelected(int index);

index
An index of an item
Return value
A selection status

It returns a selection status of the specified item.

It is necessary to enable a multi selection mode by SetMultiSelection() to get a selection status of an item.


void MQListBox::SetItemSelected(int index, bool selected);

index
An index of an item
selected
A selection status

It sets a selection status of the specified item.

It is necessary to enable a multi selection mode by SetMultiSelection() to get a selection status of an item.


std::wstring MQListBox::GetItemHint(int index);

index
An index of an item
Return value
A hint string

It returns a hint string of the specified item.


void MQListBox::SetItemHint(int index, const std::wstring& hint);

index
An index of an item
hint
A hint string

It sets a hint string of the specified item.


int MQListBox::GetVisibleRow();

Return value
A number of visible rows

It returns a number of visible rows used for a size calculation.

The value does not necessarily match the number of rows that are actually displayed.


void MQListBox::SetVisibleRow(int value);

value
A number of visible rows

It specifies a number of visible rows used for a size calculation.

The value does not necessarily match the number of rows that are actually displayed.


double MQListBox::GetLineHeightRate();

Return value
A rate of a line height

It returns a line height as a rate for a default height.


void MQListBox::SetLineHeightRate(double value);

value
A rate of a line height

It soecifies a line height as a rate for a default height.


bool MQListBox::GetVertScrollVisible();

Return value
A visibility of a vertical scroll bar

It returns whether a vertical scroll bar is displayed or not.


void MQListBox::SetVertScrollVisible(bool value);

value
A visibility of a vertical scroll bar

It specifies whether a vertical scroll bar is displayed or not.


bool MQListBox::GetMultiSelect();

Return value
Multi selection mode

It returns whether to enable to select multiple items nor not.


void MQListBox::SetMultiSelect(bool value);

value
Multi selection mode

It specifies whether to enable to select multiple items nor not.


void MQListBox::ClearSelection();

It deselects all items for multi selections.


void MQListBox::MakeItemVisible(int index);

index
An index of an item

It adjusts a scroll position to show the specified item in the visible area.


template<typename T> void MQListBox::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 current index has been changed by user's operation.


template<typename T> void MQListBox::AddDrawItemEvent(T *p, BOOL (T::*f)(MQWidgetBase*, MQDocument, MQListBoxDrawItemParam&), 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 an event notified when an item is drawn.

BOOL T::f(MQWidgetBase* sender, MQDocument doc, MQListBoxDrawItemParam& param);

sender
A source widget that notifies an event
doc
A document
param
Parameters when an event is occurred (See the following description)
Return value
[TRUE] Finish without default drawing
[FALSE] Continue to default drawing

A position to draw a text and so on can be changed by changing X and Width in param and returning FALSE.

struct MQListBoxDrawItemParam {
	MQCanvas *Canvas;
	int ItemIndex;
	int X;
	int Y;
	int Width;
	int Height;
};
Canvas
A drawing canvas
ItemIndex
An index of an item
X
X coordinate of a drawing area
Y
Y coordinate of a drawing area
Width
A width of a drawing area
Height
A height of a drawing area