minigui-docs/programming-guide/MiniGUIProgGuidePart2Chapter17.md

其他相关类

Chapter 16 of Part 2 Other Related Classes

本章介绍一些被mGNCS非控件类。它们是被设计出来提供给控件类使用。

This chapter introduces some mGNCS non control classes. They are designed to provide for the control class to use.

mReferencedObj

该类封装一个自动计数，允许对象被传递时通过自动引用来控制该对象的生命周期。

The class encapsulate an automatic counting, allowing to control the life circle of the object through automatic quoting when the object is transferred.

该类主要用于一些非控件类上，例如mToolItem, mPropMenuMgr等类

The class is mainly used on some non control classes, such as the class of mToolItem and mPropMenuMgr etc.

• 继承关系

• Inheritance relation

• mObject

• mRefrencedObj

• 直接子类

• Direct child class

• mPropMenuMgr

• mToolItem

• mToolImage

mReferencedObj方法

Method of mReferencedObj

• 引用相关的接口，有两个：

• Quote related ports, and there are two:

%CODE{cpp}% int addRef(mReferencedObj* self); int release(mReferencedObj* self);

• 参数

• type - 菜单项类型，同MiniGUI MENUITEMINFO的定义
• MTF_STRING
• MTF_BITMAP
• MTF_BMPSTRING
• MTF_RADIOCHECK
• MTF_MARKCHECK
• MTF_SEPARATOR
• str - Item 的caption，在type == MTF_STRING或MTF_BMPSTRING有效
• bmp - item的位图，在type == MTF_BITMAP或MTF_BMPSTRING有效
• id - item的id, 必须 标记一个id
• state - item状态，同 MiniGUI MENUITEMINFO的定义
• MFS_GRAYED
• MFS_DISABLED
• MFS_CHECKED
• MFS_ENABLED
• MFS_UNCHECKED
• subMenu - 子菜单管理器
• add_data - 用户附件数据

• return : TRUE/FALSE

• 创建一个PopMenu，返回该Menu的句柄

• Parameter

• type – menu item type, same as the definition of MiniGUI MENUITEMINFO
• MTF_STRING
• MTF_BITMAP
• MTF_BMPSTRING
• MTF_RADIOCHECK
• MTF_MARKCHECK
• MTF_SEPARATOR
• caption of str – Item, valid when type == MTF_STRING or MTF_BMPSTRING
• Bit map of bmp – item, valid when type == MTF_BITMAP or MTF_BMPSTRING
• id of id – item, it is a must to mark an id
• state – item status, same as the definition of MiniGUI MENUITEMINFO
• MFS_GRAYED
• MFS_DISABLED
• MFS_CHECKED
• MFS_ENABLED
• MFS_UNCHECKED
• subMenu - sub menu manager
• add_data – additional data of the user

• return : TRUE/FALSE

• Create a PopMenu, return the sentence handle of the Menu

%CODE{cpp}% HMENU createMenu(mPopMenuMgr *self);

• params:

• owner 指出PopMenu 相关关联的对象， 它必须是一个mWidget或者其子类。PopMenu将发送MSG_COMMAND给owner

• return : 无

• 添加一个分割条到MenuItem中去

• params:

• owner points out PopMenu related object, which must be a mWidget or its child class, PopMenu will send MSG_COMMAND to owner

• return : None

• Add a segmentation bar to MenuItem

%CODE{cpp}% BOOL addSeparator(mPopMenuMgr * self);

• 将指定MenuItem的信息填充到MENUITEMINFO中去
• params:

• idx - menuitem的索引或者id
• pmii - 输出参数
• byCommand : TRUE - idx为menu item的id; FALSE - idx为 menu item的索引

• return : TRUE / FALSE

• Fill information of appointed MenuItem to MENUITEMINFO

• params:

• idx - index or id of menuitem
• pmii – output parameter
• byCommand : TRUE – idx is id of menu item; FALSE – idx is index of menu item

• return : TRUE / FALSE

mPopMenuMgr示例

Example of mPopMenuMgr

参见mMenuButton的示例

Refer to the example of mMenuButton

mToolImage

mToolImage是为mToolItem提供图片的类。该类封装了各种类型的图片，以方便用户选用

mToolImage is the class providing images to mToolItem. The class encapsulates all types of images for the convenience of the users to select

• 继承关系

• Inheritance relation

• mObject

• mReferencedObj
• mToolImage

mToolImage方法

Method of mToolImage

mToolImage的方法是开放的，下面提供的函数都是可以直接调用的

The method of mToolImage is open, and the functions provided below can be called directly

• 从一个图片对象创建新的mToolImage对象

• Create new mToolImage object from an image object %CODE{cpp}% mToolImage * ncsNewToolImage(PBITMAP pbmp, int cell_count, BOOL autoUnload, BOOL bVert);

• 释放一个mToolImage对象

• Release a mToolImage object %CODE{cpp}% void ncsFreeToolImage(mToolImage *mti);

• params:

• mti : mToolImage指针
• hdc : 目标DC句柄
• idx : 小图像索引
• prc: 目标矩形

• return TRUE/FALSE

• params:

• mti : mToolImage pointer
• hdc : objective DC sentence handle
• idx : small image index
• prc: objective rectangle

• return TRUE/FALSE

对于用户来说，主要使用创建和删除相关的函数, 绘制函数是由ToolItem使用的

For the users, mainly creating and deleting related functions are used, and draw function is used by ToolItem

mToolImage示例

Example of mToolImage

mToolItem

mToolItem是mToolbar的item的基类。这个类以及它的派生类是不公开的。用户只需要通过对外提供的API，自动创建即可。

mToolItem is the basic class of item of mToolbar. The class and its derived class are not public. Users only need to automatically create through API provided externally.

mToolbar也将自动管理mToolItem的删除

mToolbar also delete the ones automatically managing mToolItem

mToolItem的类型

Type of mToolItem

mToolItem有很多子类，对外接口上，表现为各种类型，这些定义如下：

mToolItem has many child classes. In external interface, it is manifested as all kinds of types, and these definitions are as below:

%CODE{cpp}% enum mToolItemType{ NCS_UNKNOWNTOOLITEM = 0, NCS_PUSHTOOLITEM, NCS_MENUTOOLITEM, NCS_WIDGETTOOLITEM, NCS_SEPARATORTOOLITEM };

• params:

• img : mToolImage 指针,可以为NULL
• str : 文字指针，可以为NULL, 但，img和str中必须有一个不为NULL
• flags: 定义image和str的关系
• NCS_TOOLITEM_FLAG_TEXT_LEFT/NCS_TOOLITEM_FLAG_TEXT_UP, 文本在左或者上，默认为右或者下
• NCS_TOOLITEM_FLAG_VERT, image和str垂直排列，默认是水平排列

• return : item 指针

• 创建一个Menu Tool Item

• params:

• img : mToolImage pointer, can be NULL
• str : literal pointer, can be NULL, but either *img or str must not be NULL*
• flags: define the relation between image and str
• NCS_TOOLITEM_FLAG_TEXT_LEFT/NCS_TOOLITEM_FLAG_TEXT_UP, the text is on the left or top, default is right or bottom
• NCS_TOOLITEM_FLAG_VERT, image and str are vertically arranged, and it is horizontal arrangement by default

• return : item pointer
• Create a Menu Tool Item

%CODE{cpp}% void * ncsCreateMenuToolItem(int id,
mToolImage * img,
const char * str,
UINT flags,
mPopMenuMgr * menu);

• 参数同ncsCreatePushToolItem

• 创建一个Radio Tool Item

• Parameter is same as ncsCreatePushToolItem

• Create a radio Tool Item %CODE{cpp}% void * ncsCreateRadioToolItem(int id, mToolImage * img, const char * str, UINT flags);

• params

• widget : mWidget对象指针

• return : item指针

• 创建一个分割符

• params

• widget : mWidget object pointer

• return : item pointer

• Create a separator %CODE{cpp}% void * ncsCreateSeparatorItem(void);

• 如果不能设置或者不能获取，则返回-1

• 获取或者设置CheckToolItem的Check状态

• If it cannot set or cannot get, return -1

• Get or set Check status of CheckToolItem

%CODE{cpp}% BOOL ncsToolItem_setCheck(void *self, int check_state); int ncsToolItem_getCheck(void *self);

• 仅针对menu Tool item, owner为一个mWidgt*对象

• Only aim at menu Tool item, owner is a mWidgt* object

mToolItem示例

Example of mToolItem

[Index](MStudioMGNCSV1dot0PGP2C15][Previous]] < [[MStudioMGNCSV1dot0PG) >

-- Main.XiaodongLi - 22 Feb 2010

---

<< | Table of Contents | >>