炫彩界面库论坛

 找回密码
 加入我们

QQ登录

只需一步,快速开始

查看: 6245|回复: 10

提交几个帮助文档中的书写错漏,便于作者改进

[复制链接]

该用户从未签到

发表于 2011-11-15 08:30:43 | 显示全部楼层 |阅读模式
本帖最后由 shier2817 于 2011-11-15 08:39 编辑

以下错误未注明的话,则在线帮助文档与下载得到的本地帮助同时存在该错误。
当然,如C等语言,只要引用头文件和库文件即可(头声明全都是正确的),所以下述错漏即使不修正也不会影响该类语言的调用,而类似易语言等部分编程语言,需要手动书写接口声明,参考帮助文档时容易误导用户。
==============================================================

Window - XWnd_EnableDragBorder

启用拖到窗口边框功能,如果窗口有边框的话.

void XWnd_EnableDrag(HWINDOW hWindow,bool bDrag);

参数说明:hWindow:窗口资源句柄bDrag:true窗口边框可以拖动,否则不可以拖动.

XWnd_EnableDrag 应该为 XWnd_EnableDragBorder

Window - XWnd_SetBorderSize

获取窗口边框大小,注意是炫彩GUI库逻辑上的边框大小,并非系统边框大小.

void XWnd_SetBorderSize(HWINDOW hWindow,int left,int top,int right,int bottom);

参数说明:hWindow:窗口资源句柄.left:接收左边框大小.top:接收上边框大小.right;接收右边框大小.bottom:接收下边框大小.

描述错误,不是“接收”,而应该为“设置”。

Window - XWnd_SetBKColor
设置窗口背景颜色,RGB值.

void XWnd_SetBKColor(HWINDOW hWindow,COLORREF color);

参数说明:hWindow:窗口资源句柄.color:RGB颜色值.

实际应该为 “XWnd_SetBkColor”,也就是其中的“k”大小写错误,在某些编程语言的声明中需要区分大小写的。

Window - XWnd_GetButtonClose
获取标题栏上关闭按钮.

HELE XWnd_GetButtonClose(HWINDOW hWindow)

参数说明:hWindow:窗口句柄.返回值:最小化按钮句柄.

Window - XWnd_GetButtonMax
获取标题栏上最大化按钮.

HELE XWnd_GetButtonMax(HWINDOW hWindow)

参数说明:hWindow:窗口句柄.返回值:最小化按钮句柄.

其中的描述文本书写错误,返回值分别应该为“关闭按钮句柄”和“最大化按钮句柄”。


  • TA的每日心情
    开心
    2022-1-9 18:18
  • 发表于 2011-11-16 00:18:04 | 显示全部楼层
    感谢你的热情支持,将在下个版本中改进!

    该用户从未签到

     楼主| 发表于 2011-11-18 16:28:58 | 显示全部楼层
    本帖最后由 shier2817 于 2011-11-18 17:27 编辑

    ModalWindow - XModalWnd_DoCancel
    关闭模态窗口,触发取消按钮;XModalWd_DoModal()返回XMB_CANCEL.

    void XModalWd_DoCancel(HWINDOW hWindow);

    参数说明:hWindow:模态窗口资源句柄.

    ModalWindow - XModalWnd_DoOk
    关闭模态窗口,XModalWd_DoModal()返回XMB_OK.

    void XModalWd_DoOk(HWINDOW hWindow);

    参数说明:hWindow:模态窗口资源句柄.

    ModalWindow - XModalWnd_DoModal
    启动显示模态窗口,当窗口关闭时返回.

    int XModalWd_DoModal(HWINDOW hWindow);

    参数说明:hWindow:模态窗口资源句柄.返回值:   XMB_OK:点击确定按钮退出.   XMB_CANCEL:点击取消按钮退出.   如果返回0,其他方式退出.

    ModalWindow - XModalWnd_CreateWindow
    创建模态窗口;当模态窗口关闭时,会自动销毁模态窗口资源句柄.默认情况下,模态窗口会基于父窗口坐标居中显示.

    HWINDOW XModalWd_CreateWindow(int width,int height,wchar_t *pTitle,HWND hWndParent);

    参数说明:width:宽度.height:高度.pTitle:标题.hWndParent:父窗口句柄.返回值:模态窗口资源句柄.


    其中 XModalWd_DoCancel、XModalWd_DoOk、XModalWd_DoModal、XModalWd_CreateWindow 应为 XModalWnd_DoCancel、XModalWnd_DoOk、XModalWnd_DoModal、XModalWnd_CreateWindow

    PopupMenuWindow - XPopupMenuWnd_Popup
    弹出菜单.

    bool XPopupMenuWnd_Popup(HWINDOW hWindow,HWINDOW hParentWindow,int x,int y,HELE hParentEle=NULL,int uFlags=NULL);

    参数说明:hWindow:弹出菜单资源句柄.hParentWindow:父窗口资源句柄.x:弹出菜单x坐标y:弹出菜单y坐标hParentEle:父元素资源句柄.uFlags:标识以下内容:  XM_LEFT_TOP       左上角  XM_LEFT_BOTTOM    左下脚  XM_RIGHT_TOP      右上角  XM_RIGHT_BOTTOM   右下角  XM_CENTER_LEFT    左居中  XM_CENTER_TOP     上居中  XM_CENTER_RIGHT   右居中  XM_CENTER_BOTTOM  下居中返回值:如果成功返回true,否则相反.

    这个不算什么错误,就是个笔误错别字:XM_LEFT_BOTTOM    左下


    该用户从未签到

     楼主| 发表于 2011-11-23 01:13:16 | 显示全部楼层
    晕了,这个书写错误让我以为是个BUG呢。。。程序崩溃。。。看了头文件才清楚。。。
    Edit - XEdit_GetSelectText
    获取选择的文本内容.

    HSTRING XEdit_GetSelectText(HELE hEle);

    参数说明:hEle:编辑框资源句柄.

    实际应该为:
    Edit - XEdit_GetSelectText
    获取选择的文本内容.

    void XEdit_GetSelectText(HELE hEle,wchar_t *pOut,int len);

    参数说明:hEle:编辑框资源句柄.pOut:接收内容缓冲区.len:pOut缓冲区长度.

    ,老大,这差的不是一星半点。。。还有,XEdit_GetText跟这个是一样的,但是那个 len 使用 XEdit_GetTextLength 传递即可。当然这个也可以传递 XEdit_GetTextLength,只不过有可能长,但是却不会短的。。。要是,有个接口可以获取选中文本长度就好了。。。

    另外,建议把这个帖子移动到 BUG 区,我一定会把帮助文档都读完的。。。

    该用户从未签到

     楼主| 发表于 2011-11-23 13:38:40 | 显示全部楼层
    ComboBox - XComboBox_GetListHeight
    获取下拉列表高度.

    int  XComboBox_GetListHeight(HELE hEle);

    参数说明:hEle:组合框元素资源句柄.返回值:下拉列表高度.

    ComboBox - XComboBox_SetDropDownListHeight
    设置下拉列表高度.

    void XComboBox_SetDropDownListHeight(HELE hEle,int height);

    参数说明:hEle:组合框元素资源句柄.height:高度.

    这两个没有任何错误,但这是一对对应接口,貌似接口名称不太符合程序书写规范哦,这样对程序编写时就增加了记忆难度喽。

    该用户从未签到

     楼主| 发表于 2011-11-24 13:21:53 | 显示全部楼层
    本帖最后由 shier2817 于 2011-11-24 14:25 编辑

    ScrollBar - XSBar_Create
    创建滚动条.

    HELE XSBar_Create(int x,int y,int cx,int cy,int style,HXCGUI hParent=NULL);

    参数说明:x:元素x坐标.y;元素y坐标.cx:宽度.cy:高度.hParent:父是窗口资源句柄或UI元素资源句柄.如果是窗口资源句柄将被添加到窗口,如果是元素资源句柄将被添加到元素.返回值:所创建的元素UI资源句柄.

    如果按照头文件描述,其中 int style 应为 bool bHorizon, true 为水平滚动条,否则为垂直滚动条。但是帮助文档中这个也可以,只要取值常量:SY_HSCROLL 和 SY_VSCROLL 即可。。。本来这2个常量也就是个逻辑值,所以两种方式都可以。但这样就不够严谨了。。。所以希望下个版本可以统一一下,无论是用常量还是逻辑值都行,但选一种就好了。。。
    建议还是逻辑值比较方便。


    该用户从未签到

     楼主| 发表于 2011-11-25 00:01:34 | 显示全部楼层
    Element - XEle_EnableToolTip
    元素启用工具提示功能.

    void XEle_EnableToolTip(HELE hEle,bool bTip);

    参数说明:hEle:元素资源句柄bTip;true启用工具提示,否则相反.

    Element - XEle_SetToolTip
    设置元素工具提示内容.

    void XEle_SetToolTip(HELE hEle,wchar_t *pText);

    参数说明:hEle:元素资源句柄.pText:文本内容.

    其中 XEle_EnableToolTip 和 XEle_SetToolTip 实际应为 XEle_EnableToolTips 和 XEle_SetToolTips

    不过 XEle_GetTooltip 接口却是正确的,就是说没有 "s",其实这样不太对应哦。。。

    该用户从未签到

     楼主| 发表于 2011-11-26 12:39:31 | 显示全部楼层
    ScrollView - XSView_IsHScrollBarVisible
    水平滚动条当前是否可见.

    int XSView_IsHScrollBarVisible(HELE hEle)

    参数说明:hEle:元素句柄.返回值:如果水平滚动条当前可见,返回true,否则相反.

    ScrollView - XSView_IsVScrollBarVisible
    滚动视图元素,垂直滚动条当前是否可见.

    int XSView_IsVScrollBarVisible(HELE hEle)

    参数说明:hEle:元素句柄.返回值:如果垂直滚动条当前可见,返回true,否则相反.

    这两个没有错误,与头文件声明也相同,不过根据返回值和接口作用,其返回类型应该为 bool 更贴切些吧。。。
  • TA的每日心情
    开心
    2022-1-9 18:18
  • 发表于 2011-11-26 19:20:26 | 显示全部楼层
    恩是的,下个版本修正.

    该用户从未签到

     楼主| 发表于 2011-11-27 17:27:57 | 显示全部楼层
    本帖最后由 shier2817 于 2011-11-27 18:52 编辑

    List - XList_CancelSelect
    取消选择指定项.

    void Xlist_CancelSelect(HELE hEle,int index);

    参数说明:hEle:列表框资源句柄.index:项索引.

    在声明部分“void Xlist_CancelSelect” 应该为 “void XList_CancelSelect”


    List - XList_SetUserDrawItem

    设置用户自绘列表项.

    void XList_SetUserDrawItem(HELE hEle,pFunList_DrawItem pFunDrawItem)pFunDrawItem类型:void CALLBACK *pFunList_DrawItem(HELE hEle,HDC hdc,int index,int subIndex,int imageId,int state,RECT *pRect,wchar_t *pText);

    参数说明:hEle:元素句柄pFunDrawItem:自绘函数地址.参数pFunDrawItem类型参数:hEle:元素句柄.hDC:图形设备上下文DC句柄.index:列表项索引.subIndex:列表项子项索引.imageId:图标索引.state:状态.pRect:坐标.pText:文本内容.

    实际应该修改为:
    List - XList_SetUserDrawItem
    设置用户自绘列表项.

    void XList_SetUserDrawItem(HELE hEle,pFunList_DrawItem pFunDrawItem)pFunDrawItem类型:void CALLBACK *pFunList_DrawItem(HELE hEle,HDC hdc,int index,int subIndex,int imageId,int state,RECT *pRect,RECT *prcCheck,wchar_t *pText);

    参数说明:hEle:元素句柄pFunDrawItem:自绘函数地址.参数pFunDrawItem类型参数:hEle:元素句柄.hDC:图形设备上下文DC句柄.index:列表项索引.subIndex:列表项子项索引.imageId:图标索引.state:状态.pRect:坐标.prcCheck:这里貌似是检查框坐标。pText:文本内容.

    您需要登录后才可以回帖 登录 | 加入我们

    本版积分规则

    QQ|Archiver|手机版|小黑屋|炫彩界面库 ( 鄂ICP备2023014763号-1 )

    GMT+8, 2024-5-4 09:43 , Processed in 0.071159 second(s), 18 queries .

    Powered by Discuz! X3.4

    Copyright © 2001-2021, Tencent Cloud.

    快速回复 返回顶部 返回列表