MzProgressDialog类参考

用于显示进度的对话框 更多...

#include <MzProgressDialog.h>

所有成员的列表。

公有成员
void	BeginProgress (HWND parent)
	开始显示进度窗口
void	EndProgress ()
	结束进度窗口
INT64	GetCurValue ()
	获得进度当前位置的值
BOOL	GetExtendedProperty_MzProgressDialog (int nPropertyType, void *pValue, int nBufSize)
	获取或设置对象的扩展属性值
INT64	GetMaxValue ()
	设置进度的最大值
INT64	GetMinValue ()
	设置进度的最小值
bool	IsContinue ()
	判断是否需要继续，当点击了左下角的按钮后，IsContinue将得到false，程序中可每隔一定时间调用IsContinue来判断是否该结束相应操作
	MzProgressDialog ()
void	SetButtonMessage (UINT message)
	允许用户设置一个消息，当用户点击左下角按钮后，进度显示窗口会向父窗口发送这个消息
void	SetButtonText (const TCHAR *btnText=NULL)
	设置左下角按钮文字
void	SetCurValue (INT64 curValue)
	设置进度当前位置的值
BOOL	SetExtendedProperty_MzProgressDialog (int nPropertyType, void *pValue, int nBufSize)
	获取或设置对象的扩展属性值
void	SetInfo (const TCHAR *info=NULL)
	设置提示文字
void	SetRange (INT64 min, INT64 max)
	设置进度的最大值和最小值
void	SetRoundRect (bool round)
	设置窗口是否是上半圆角的，默认为true
void	SetShowInfo (bool showInfo)
	设置进度条下方是否显示信息
void	SetShowTitle (bool showTitle)
	设置进度条上方是否显示标题
void	SetSleepEnable (bool enable, int timeoutMilliSec)
	设置在进度显示的过程中，是否允许系统进入睡眠状态
void	SetTitle (const TCHAR *title=NULL)
	设置标题文字
void	SetWindowHeight (int height)
	设置窗口高度
void	SetWindowTitle (const TCHAR *wndTitle=NULL)
	设置系统任务栏上显示的窗口标题，默认为不显示
void	UpdateProgress ()
	更新进度窗口所显示的内容
	~MzProgressDialog ()

---

详细描述

用于显示进度的对话框

对话框由标题、进度条、信息和左下角按钮组成，可以选择是否显示标题，是否显示信息，根据不同的选择，界面会自动调整

---

构造及析构函数文档

MzProgressDialog::MzProgressDialog

(

)

MzProgressDialog::~MzProgressDialog

(

)

---

成员函数文档

void MzProgressDialog::BeginProgress

(

HWND

parent

)

开始显示进度窗口

参数:

parent

进度对话框的父窗口，当进度对话框显示时，会使父窗口无效

void MzProgressDialog::EndProgress

(

)

结束进度窗口

INT64 MzProgressDialog::GetCurValue

(

)

获得进度当前位置的值

BOOL MzProgressDialog::GetExtendedProperty_MzProgressDialog	(	int	nPropertyType,
		void *	pValue,
		int	nBufSize
	)

获取或设置对象的扩展属性值

参数:

	nPropertyType	要获取或设置的属性类型
	pValue	要获取或设置的属性值的指针
	nBufSize	pValue所指向的变量的size大小（单位: 字节）

返回:

操作是否成功

INT64 MzProgressDialog::GetMaxValue

(

)

设置进度的最大值

INT64 MzProgressDialog::GetMinValue

(

)

设置进度的最小值

bool MzProgressDialog::IsContinue

(

)

判断是否需要继续，当点击了左下角的按钮后，IsContinue将得到false，程序中可每隔一定时间调用IsContinue来判断是否该结束相应操作

void MzProgressDialog::SetButtonMessage

(

UINT

message

)

允许用户设置一个消息，当用户点击左下角按钮后，进度显示窗口会向父窗口发送这个消息

void MzProgressDialog::SetButtonText

(

const TCHAR *

btnText = NULL

)

设置左下角按钮文字

BtnText为空时，左下角文字不显示，且按钮不可用

void MzProgressDialog::SetCurValue

(

INT64

curValue

)

设置进度当前位置的值

BOOL MzProgressDialog::SetExtendedProperty_MzProgressDialog	(	int	nPropertyType,
		void *	pValue,
		int	nBufSize
	)

获取或设置对象的扩展属性值

参数:

	nPropertyType	要获取或设置的属性类型
	pValue	要设置的属性值的指针
	nBufSize	pValue所指向的变量的size大小（单位: 字节）

返回:

操作是否成功

void MzProgressDialog::SetInfo

(

const TCHAR *

info = NULL

)

设置提示文字

void MzProgressDialog::SetRange	(	INT64	min,
		INT64	max
	)

设置进度的最大值和最小值

void MzProgressDialog::SetRoundRect

(

bool

round

)

设置窗口是否是上半圆角的，默认为true

void MzProgressDialog::SetShowInfo

(

bool

showInfo

)

设置进度条下方是否显示信息

void MzProgressDialog::SetShowTitle

(

bool

showTitle

)

设置进度条上方是否显示标题

void MzProgressDialog::SetSleepEnable	(	bool	enable,
		int	timeoutMilliSec
	)

设置在进度显示的过程中，是否允许系统进入睡眠状态

默认是允许，中途可以改变此设置 设 enable 为 false 即 不允许睡眠 后，将每隔 timeoutMilliSec 毫秒 调用一次 SystemIdleTimerReset() 这个API

void MzProgressDialog::SetTitle

(

const TCHAR *

title = NULL

)

设置标题文字

void MzProgressDialog::SetWindowHeight

(

int

height

)

设置窗口高度

根据是否显示标题和提示有一个默认窗口高度 如果程序设置了高度，并且高度大于默认的高度，则使用程序设置的高度 如果输入法当时正打开，且窗口高度小于输入法高度 则窗口高度将强制使用输入法的高度，且窗口将强制不使用上半圆角

void MzProgressDialog::SetWindowTitle

(

const TCHAR *

wndTitle = NULL

)

设置系统任务栏上显示的窗口标题，默认为不显示

void MzProgressDialog::UpdateProgress

(

)

更新进度窗口所显示的内容

程序可自行控制进度窗口界面刷新的时机，不需要每次设置标题或者信息后都刷新

---

该类的文档由以下文件生成：

• MzProgressDialog.h