C++ Syntax

bool

MKI_DialogWidth(

HWND f_hWindow,

const LPCWSTR f_pszCaption,

const LPCWSTR f_pszPrefix,

LPWSTR f_pszText,

double& f_dWidth )

Shows and processes the dialog that allows editing a width value. The width's unit and scale will be determined by the currently active coordinate system in the current drawing's active window.

Parameters

Window

[HWND] Handle of the dialog window's parent window.

Caption

[const LPCWSTR] Title of the dialog window to be displayed. Be careful that the given title fits into the dialog window's caption.

Prefix

[const LPCWSTR] Text to be displayed in front of the edit field. Be careful that the given text fits into the dialog.

Text

[LPWSTR] If not nullptr, this is the address of the textual representation of the value used for editing. The text buffer must be at least MKI_LENGTH_TEXT_SHORT characters long! Use this to store the complete term used to determine the actual value (e.g. "4/3" instead of 1.3333333) for reasons of better usability and accuracy. If nullptr, the value will be edited directly.

Width

[double&] Address of the width value to be edited.

Return Value

Returns true if the dialog window was ended by pressing the OK button (no matter if anything inside the window was changed), else false.