就业培训     下载中心     Wiki     联络 登录   注册

---

1. 首页
2. C4D R23.110 C++ SDK

公共成员函数 | Protected Attributes | 私有成员函数 | Private Attributes | Friends | 所有成员列表

GeDialog Class Reference

#include <c4d_gui.h>

Inheritance diagram for GeDialog:

[ legend ]

详细描述

Used to display GUI dialogs. Derive this class, overriding the necessary functions, and then call Open() to display it.

公共成员函数
Bool	SetColorField (const GadgetPtr &id, const TriState < 向量 > &tri, Float brightness, Float maxbrightness, Int32 flags)

Protected Attributes
Bool	createlayout

私有成员函数
	MAXON_DISALLOW_COPY_AND_ASSIGN ( GeDialog )

Private Attributes
CDialog *	cd
Int32	t_lastcoremsg

Friends
class	GeUserArea
class	_GeListView

Constructor/Destructor
	GeDialog (void)
virtual	~GeDialog (void)

Internal Representation
CDialog *	Get ()

Override
virtual Bool	CreateLayout (void)
virtual Bool	InitValues (void)
virtual Bool	CoreMessage ( Int32 id, const BaseContainer &msg)
virtual Bool	命令 ( Int32 id, const BaseContainer &msg)
virtual Bool	AskClose (void)
virtual void	Timer (const BaseContainer &msg)
virtual void	DestroyWindow (void)
virtual Int32	消息 (const BaseContainer &msg, BaseContainer &result)

Open/Close
Bool	Open ( DLG_TYPE dlgtype, Int32 pluginid, Int32 xpos=-1, Int32 ypos=-1, Int32 defaultw=0, Int32 defaulth=0, Int32 subid=0)
Bool	关闭 (void)
Bool	关闭 ( Bool dummy)

Basic Functions
GeData	SendMessage (const GadgetPtr &id, const BaseContainer &msg)
Bool	SendParentMessage (const BaseContainer &msg, Bool receiveSelf=false)
Int32	GetId (void)
Bool	IsOpen ()
Bool	IsVisible ()
void	SetTimer ( Int32 timer)
void	SetTitle (const maxon::String &title)
maxon::String	GetTitle ()
Bool	启用 (const GadgetPtr &id, Bool enabled)
Bool	IsEnabled (const GadgetPtr &id)

Input
Bool	GetInputState ( Int32 askdevice, Int32 askchannel, BaseContainer &res)
Bool	GetInputEvent ( Int32 askdevice, BaseContainer &res)
void	KillEvents (void)

Plain Set
Bool	SetBool (const GadgetPtr &id, Int32 value, Int32 tristate=0)
Bool	SetInt32 (const GadgetPtr &id, Int32 value, Int32 min= LIMIT < Int32 >:: MIN , Int32 max= LIMIT < Int32 >:: MAX , Int32 step=1, Int32 tristate=0, Int32 min2= LIMIT < Int32 >:: MIN , Int32 max2= LIMIT < Int32 >:: MAX )
Bool	SetFloat (const GadgetPtr &id, Float value, Float min=(-1.0e18), Float max=(1.0e18), Float step=1.0, Int32 format= FORMAT_FLOAT , Float min2=0.0, Float max2=0.0, Bool quadscale=false, Int32 tristate=0)
Bool	SetMeter (const GadgetPtr &id, Float value, Float min=(-1.0e18), Float max=(1.0e18), Float step=1.0, Int32 tristate=0)
Bool	SetDegree (const GadgetPtr &id, Float radians_value, Float min=(-1.0e18), Float max=(1.0e18), Float step=1.0, Int32 tristate=0)
Bool	SetPercent (const GadgetPtr &id, Float value, Float min=0.0, Float max=100.0, Float step=1.0, Int32 tristate=0)
Bool	SetTime (const GadgetPtr &id, const BaseDocument *doc, const BaseTime &value, const BaseTime &min= BaseTime (- 108000, 1), const BaseTime &max= BaseTime (108000, 1), Int32 stepframes=1, Int32 tristate=0)
Bool	SetString (const GadgetPtr &id, const maxon::String &text, Int32 tristate=0, Int32 flags=0)
Bool	SetColorField (const GadgetPtr &id, const 向量 &color, Float brightness, Float maxbrightness, Int32 flags)
Bool	SetFilename (const GadgetPtr &id, const Filename &fn, Int32 tristate=0)

Plain Get
Bool	GetBool (const GadgetPtr &id, Bool &value) const
Bool	GetInt32 (const GadgetPtr &id, Int32 &value) const
Bool	GetFloat (const GadgetPtr &id, Float &value) const
Bool	GetVector (const GadgetPtr &id_x, const GadgetPtr &id_y, const GadgetPtr &id_z, 向量 &value) const
Bool	GetString (const GadgetPtr &id, maxon::String &text) const
Bool	GetColorField (const GadgetPtr &id, 向量 &color, Float &brightness) const
Bool	GetTime (const GadgetPtr &id, const BaseDocument *doc, BaseTime &time) const
Bool	GetFilename (const GadgetPtr &id, Filename &fn) const
Bool	CheckTristateChange (const GadgetPtr &id)

Container Set
Bool	SetBool (const GadgetPtr &id, const BaseContainer *bc, Int32 bcid)
Bool	SetInt32 (const GadgetPtr &id, const BaseContainer *bc, Int32 bcid, Int32 min= LIMIT < Int32 >:: MIN , Int32 max= LIMIT < Int32 >:: MAX , Int32 step=1, Int32 min2= LIMIT < Int32 >:: MIN , Int32 max2= LIMIT < Int32 >:: MAX )
Bool	SetFloat (const GadgetPtr &id, const BaseContainer *bc, Int32 bcid, Float min=(-1.0e18), Float max=(1.0e18), Float step=1.0, Int32 format= FORMAT_FLOAT , Float min2=0.0, Float max2=0.0, Bool quadscale=false)
Bool	SetMeter (const GadgetPtr &id, const BaseContainer *bc, Int32 bcid, Float min=(-1.0e18), Float max=(1.0e18), Float step=1.0)
Bool	SetDegree (const GadgetPtr &id, const BaseContainer *bc, Int32 bcid, Float min=(-1.0e18), Float max=(1.0e18), Float step=1.0)
Bool	SetPercent (const GadgetPtr &id, const BaseContainer *bc, Int32 bcid, Float min=0.0, Float max=100.0, Float step=1.0)
Bool	SetTime (const GadgetPtr &id, const BaseDocument *doc, const BaseContainer *bc, Int32 bcid, const BaseTime &min= BaseTime (- 108000, 1), const BaseTime &max= BaseTime (108000, 1), Int32 stepframes=1)
Bool	SetString (const GadgetPtr &id, const BaseContainer *bc, Int32 bcid, Int32 flags=0)
Bool	SetFilename (const GadgetPtr &id, const BaseContainer *bc, Int32 bcid)
Bool	SetColorField (const GadgetPtr &id, const BaseContainer *bc, Int32 bc_colid, Int32 bc_brightnessid, Float maxbrightness, Int32 flags)

Container Get
Bool	GetBool (const GadgetPtr &id, BaseContainer *bc, Int32 bcid) const
Bool	GetInt32 (const GadgetPtr &id, BaseContainer *bc, Int32 bcid) const
Bool	GetFloat (const GadgetPtr &id, BaseContainer *bc, Int32 bcid) const
Bool	GetTime (const GadgetPtr &id, const BaseDocument *doc, BaseContainer *bc, Int32 bcid) const
Bool	GetVector (const GadgetPtr &id_x, const GadgetPtr &id_y, const GadgetPtr &id_z, BaseContainer *bc, Int32 bcid) const
Bool	GetString (const GadgetPtr &id, BaseContainer *bc, Int32 bcid) const
Bool	GetFilename (const GadgetPtr &id, BaseContainer *bc, Int32 bcid) const
Bool	GetColorField (const GadgetPtr &id, BaseContainer *bc, Int32 bc_colid, Int32 bc_brightnessid) const

TriState Set
Bool	SetBool (const GadgetPtr &id, const TriState < Bool > &tri)
Bool	SetInt32 (const GadgetPtr &id, const TriState < Int32 > &tri, Int32 min= LIMIT < Int32 >:: MIN , Int32 max= LIMIT < Int32 >:: MAX , Int32 step=1, Int32 min2= LIMIT < Int32 >:: MIN , Int32 max2= LIMIT < Int32 >:: MAX )
Bool	SetFloat (const GadgetPtr &id, const TriState < Float > &tri, Float min=(-1.0e18), Float max=(1.0e18), Float step=1.0, Int32 format= FORMAT_FLOAT , Float min2=0.0, Float max2=0.0, Bool quadscale=false)
Bool	SetMeter (const GadgetPtr &id, const TriState < Float > &tri, Float min=(-1.0e18), Float max=(1.0e18), Float step=1.0)
Bool	SetDegree (const GadgetPtr &id, const TriState < Float > &tri, Float min=(-1.0e18), Float max=(1.0e18), Float step=1.0)
Bool	SetPercent (const GadgetPtr &id, const TriState < Float > &tri, Float min=0.0, Float max=100.0, Float step=1.0)
Bool	SetTime (const GadgetPtr &id, const BaseDocument *doc, const TriState < BaseTime > &tri, const BaseTime &min= BaseTime (- 108000, 1), const BaseTime &max= BaseTime (108000, 1), Int32 stepframes=1)
Bool	SetString (const GadgetPtr &id, const TriState < String > &tri, Int32 flags=0)

Coordinates Transformation
Bool	Local2Global ( Int32 *x, Int32 *y)
Bool	Global2Local ( Int32 *x, Int32 *y)
Bool	Screen2Local ( Int32 *x, Int32 *y)
Bool	Local2Screen ( Int32 *x, Int32 *y)

颜色
Bool	GetColorRGB ( Int32 colorid, Int32 &r, Int32 &g, Int32 &b)
void	SetDefaultColor (const GadgetPtr &id, Int32 colorid, Int32 mapid)
void	SetDefaultColor (const GadgetPtr &id, Int32 colorid, const 向量 &color)

Layout
Bool	LoadDialogResource ( Int32 id, GeResource *lr, Int32 flags)
C4DGadget *	AddCheckbox ( Int32 id, Int32 flags, Int32 initw, Int32 inith, const maxon::String &name)
C4DGadget *	AddButton ( Int32 id, Int32 flags, Int32 initw, Int32 inith, const maxon::String &name)
C4DGadget *	AddStaticText ( Int32 id, Int32 flags, Int32 initw, Int32 inith, const maxon::String &name, Int32 borderstyle)
C4DGadget *	AddArrowButton ( Int32 id, Int32 flags, Int32 initw, Int32 inith, Int32 arrowtype)
C4DGadget *	AddEditText ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0, Int32 editflags=0)
C4DGadget *	AddMultiLineEditText ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0, Int32 style=0)
C4DGadget *	AddEditNumber ( Int32 id, Int32 flags, Int32 initw=80, Int32 inith=0)
C4DGadget *	AddEditNumberArrows ( Int32 id, Int32 flags, Int32 initw=70, Int32 inith=0)
C4DGadget *	AddEditSlider ( Int32 id, Int32 flags, Int32 initw=80, Int32 inith=0)
C4DGadget *	AddSlider ( Int32 id, Int32 flags, Int32 initw=90, Int32 inith=0)
C4DGadget *	AddColorField ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0, Int32 colorflags=0)
C4DGadget *	AddColorChooser ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0, Int32 layoutflags=0, const BaseContainer &settings= BaseContainer ())
C4DGadget *	AddRadioButton ( Int32 id, Int32 flags, Int32 initw, Int32 inith, const maxon::String &name)
C4DGadget *	AddRadioText ( Int32 id, Int32 flags, Int32 initw, Int32 inith, const maxon::String &name)
C4DGadget *	AddEditShortcut ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0, Int32 shortcutflags=0)
C4DGadget *	AddSeparatorH ( Int32 initw, Int32 flags= BFH_FIT )
C4DGadget *	AddSeparatorV ( Int32 inith, Int32 flags= BFV_FIT )
Bool	AddRadioGroup ( Int32 id, Int32 flags, Int32 columns=1, Int32 rows=0)
C4DGadget *	AddComboBox ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0, Bool specialalign=false, Bool allowFiltering=false)
C4DGadget *	AddComboButton ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0, Bool specialalign=false, Bool allowFiltering=false)
C4DGadget *	AddPopupButton ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0, Bool allowFiltering=false)
Bool	AddListView ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0)
Bool	LayoutChanged (const GadgetPtr &id)
Bool	LayoutChangedNoRedraw (const GadgetPtr &id)
Bool	激活 (const GadgetPtr &id)
Bool	IsActive (const GadgetPtr &id)
UpdateDialogHelper	BeginLayoutChange (const GadgetPtr &gadget, Bool disableRedraws)
Bool	LayoutFlushGroup (const GadgetPtr &id)
Bool	LayoutFlushDisableRedraw (const GadgetPtr &id, Bool disable)
Bool	RemoveElement (const GadgetPtr &id)
Bool	HideElement (const GadgetPtr &id, Bool hide)
Bool	RestoreLayout ( Int32 pluginid, Int32 subid, void *secret)

Layout Helpers
Bool	AddChild (const GadgetPtr &id, Int32 subid, const maxon::String &child)
Bool	FreeChildren (const GadgetPtr &id)
Bool	SetPopup (const GadgetPtr &id, const BaseContainer &bc)
Bool	AddChildren (const GadgetPtr &id, const BaseContainer &bc)
C4DGadget *	AddUserArea ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0)
Bool	AttachUserArea ( GeUserArea &ua, const GadgetPtr &id, USERAREAFLAGS userareaflags= USERAREAFLAGS::COREMESSAGE )
Bool	AddSubDialog ( Int32 id, Int32 flags, Int32 initw=0, Int32 inith=0)
Bool	AttachSubDialog ( SubDialog *userdlg, Int32 id)
Bool	AddDlgGroup ( Int32 type)

Group
Bool	GroupBeginInMenuLine ()
Bool	TabGroupBegin ( Int32 id, Int32 flags, Int32 tabtype= TAB_TABS )
Bool	GroupBegin ( Int32 id, Int32 flags, Int32 cols, Int32 rows, const maxon::String &title, Int32 groupflags, Int32 initw=0, Int32 inith=0)
Bool	GroupEnd (void)
Bool	GroupSpace ( Int32 spacex, Int32 spacey)
Bool	GroupBorder ( UInt32 borderstyle)
Bool	GroupBorderNoTitle ( UInt32 borderstyle)
Bool	GroupBorderSpace ( Int32 left, Int32 top, Int32 right, Int32 bottom)
Bool	GroupWeightsSave (const GadgetPtr &id, BaseContainer &weights)
Bool	GroupWeightsLoad (const GadgetPtr &id, const BaseContainer &weights)

Drag and Drop
Bool	GetItemDim (const GadgetPtr &id, Int32 *x, Int32 *y, Int32 *w, Int32 *h) const
Bool	GetDragPosition (const BaseContainer &msg, Int32 *x, Int32 *y)
Bool	GetDragObject (const BaseContainer &msg, Int32 *type, void **object)
Bool	SetDragDestination ( Int32 cursor, Int32 gadgetid=0)
Bool	CheckDropArea (const GadgetPtr &id, const BaseContainer &msg, Bool horiz, Bool vert)

Scroll Group
Bool	GetVisibleArea ( Int32 scrollgroupid, Int32 *x1, Int32 *y1, Int32 *x2, Int32 *y2)
Bool	SetVisibleArea ( Int32 scrollgroupid, Int32 x1, Int32 y1, Int32 x2, Int32 y2)
Bool	ScrollGroupBegin ( Int32 id, Int32 flags, Int32 scrollflags, Int32 initw=0, Int32 inith=0)

菜单
Bool	MenuFlushAll (void)
Bool	MenuSubBegin (const maxon::String &string)
Bool	MenuSubEnd (void)
Bool	MenuAddCommand ( Int32 cmdid)
Bool	MenuAddString ( Int32 id, const maxon::String &string)
Bool	MenuAddSeparator (void)
Bool	MenuFinished (void)
Bool	MenuInitString ( Int32 id, Bool enabled, Bool checked)
Bool	MenuSetResource ( Int32 id)

Custom GUI
void *	FindCustomGui ( Int32 id, Int32 pluginid)
void *	AddCustomGui ( Int32 id, Int32 pluginid, const maxon::String &name, Int32 flags, Int32 minw, Int32 minh, const BaseContainer &customdata)

Multi-line Edit
Bool	SetMultiLineMode (const GadgetPtr &id, SCRIPTMODE mode)
Bool	SetMultiLineLock (const GadgetPtr &id, Bool lock)
Bool	SetMultiLinePos (const GadgetPtr &id, Int32 line, Int32 pos)

杂项
Bool	CheckClose (void)
Bool	CheckValueRanges (void)
Float	GetPixelRatio () const
Bool	ReleaseLink ()
Bool	CheckCoreMessage (const BaseContainer &msg, Int32 *ownlastcoremsg=nullptr)
void *	GetWindowHandle ()
static void	HandleHelpString (const BaseContainer &msg, BaseContainer &result, const maxon::String &sym)

构造函数 & 析构函数文档编制

◆  GeDialog()

GeDialog

(

void

)

Creates the dialog, but does not open it.

◆  ~GeDialog()

virtual ~ GeDialog ( void  )

virtual

Destroys the dialog. If the dialog is still open, it is closed.

成员函数文档编制

◆  MAXON_DISALLOW_COPY_AND_ASSIGN()

MAXON_DISALLOW_COPY_AND_ASSIGN ( GeDialog   )

private

◆  Get()

Retrieves a pointer to the internal dialog pointer.

返回

The internal dialog.

◆  CreateLayout()

Called when the dialog is about to be displayed. Override this method to define the layout of the dialog.
Either use the recommended LoadDialogResource function or the manual functions (for example AddButton() ). See 对话框布局 了解更多信息。

返回

true if successful, otherwise false .

Reimplemented in ProgressDialog ，和 SDKBrowserPreviewDialog .

◆  InitValues()

Called when the dialog is initialized by the GUI. Override this method to initialize local variables and the gadgets used.

另请参阅

The article GUI Messages 了解更多信息。

返回

true if successful, otherwise false .

Reimplemented in ProgressDialog ，和 SDKBrowserPreviewDialog .

◆  CoreMessage()

Override this method to react to Cinema 4D core messages.

另请参阅

The article Core Messages 了解更多信息。

参数

[in]	id	The message ID: EVMSG
[in]	msg	The message container.

返回

Currently not used.

Reimplemented in SDKBrowserPreviewDialog .

◆  Command()

Whenever the user clicks on a gadget and/or changes its value this function will be called. It is also called when a string menu item is selected. Override this methods to handle such events.

注意

Remember StopAllThreads() must be called before making modifications to the scene.

参数

[in]	id	The ID of the gadget that triggered the event.
[in]	msg	The message container. Contains the following values: BFM_ACTION_ID and BFM_ACTION_VALUE .

返回

true if successful, otherwise false .

Reimplemented in ProgressDialog ，和 SDKBrowserPreviewDialog .

◆  AskClose()

If the user wants to close the dialog with the OK button this function will be called. Override it to avoid closing the dialog if an error situation has occurred.
若 false is returned everything will be as usual, but if true is returned the dialog will not close. This function is especially useful in combination with the GeModalDialog class for handling wrong user input before leaving the dialog.

警告

A buggy function, always returning true , will lead to a frustrating user experience.

返回

true if the dialog should not be closed, false if it should.

Reimplemented in ProgressDialog ，和 SDKBrowserPreviewDialog .

◆  Timer()

Called when a timer event is received.
To subscribe to timer events use SetTimer() .

参数

[in]

msg

The timer message container.

Reimplemented in ProgressDialog ，和 SDKBrowserPreviewDialog .

◆  DestroyWindow()

Called when the dialog is about to be closed temporarily, for example for layout switching.
All pointers to C4DGadget , GeUserArea and SubDialog objects as well as custom GUI objects are invalidated. So set all such stored pointers to nullptr .
CreateLayout will be called when the dialog is restored.

Reimplemented in SDKBrowserPreviewDialog .

◆  Message()

Called when a message is received.
Override this function to react to more messages than covered by the other virtual functions. Normally this is not necessary.

注意

If overriden, be sure to include a call to the base version of this function, GeDialog::Message() .

另请参阅

The article GUI Messages 了解更多信息。

参数

[in]	msg	The message container.
[in]	result	A container to place results in.

返回

Depends on the message.

Reimplemented in ProgressDialog , iCustomGui , SubDialog , GeModalDialog ，和 SDKBrowserPreviewDialog .

◆  Open()

Opens the dialog at the specified position.

注意

若 xpos = -1 and ypos = -1 the dialog will be opened at the current mouse position.
若 xpos = -2 and ypos = -2 the dialog will be opened at the center of the screen.

Make sure to pass the ID for asynchronous plugins so that Cinema 4D can correctly restore dialogs added by the user to the user interface.

参数

[in]	dlgtype	The dialog type: DLG_TYPE
[in]	pluginid	The plugin ID of the CommandData with the dialog's CommandData::RestoreLayout() .
[in]	xpos	The X position of the dialog. See note above.
[in]	ypos	The Y position of the dialog. See note above.
[in]	defaultw	The default width of the dialog in pixels.
[in]	defaulth	The default height of the dialog in pixels.
[in]	subid	The dialog sub-ID. This can be used to open several dialogs with a single command plugin for CommandData::ExecuteSubID() .

返回

true if successful, otherwise false .

◆  Close() [1/2]

Closes the dialog. Not necessary when using modal dialogs.

返回

true if the dialog was closed, otherwise false .

◆  Close() [2/2]

Always calls Close(void) .

参数

[in]

dummy

A dummy boolean state.

◆  SendMessage()

Sends a message to a dialog element by ID.

另请参阅

The article GUI Messages 了解更多信息。

参数

[in]	id	The dialog element ID.
[in]	msg	The message container.

返回

Depends on the message sent.

◆  SendParentMessage()

Sends a message to the parent dialog.

另请参阅

The article GUI Messages 了解更多信息。

参数

[in]	msg	The message container.
[in]	receiveSelf	True if the own parent message should process this message. Default is false.

返回

true if the message was sent, otherwise false .

◆  GetId()

Gets the dialog ID.

返回

The dialog ID.

◆  IsOpen()

Checks if the dialog is open.

返回

true if the dialog is open, otherwise false .

◆  IsVisible()

Checks if the dialog is visible.

返回

true if the dialog is visible, otherwise false .

◆  SetTimer()

Initializes the timer clock, so that Timer() is called every timer milliseconds. Use SetTimer(0) to stop the timer.

注意

Depending on the speed of the computer, the operating system, the complexity of the dialog and the threads running in the background, there is no guarantee that event messages will occur on a regular basis.
Using a value of 500 ms should be no problem but using a value of 1 ms one might get events with the following time spaces: 3 ms, 76 ms, 15 ms, 19 ms, 67 ms etc.

警告

Keep in mind that using small timer values results in heavy message traffic in the application which may slow down Cinema 4D (and all other applications running on the computer) to a point where nothing is working any longer besides the dialog.

参数

[in]

timer

The timer interval in milliseconds. Pass 0 to stop the timer.

◆  SetTitle()

Sets the title of the dialog window.

参数

[in]

title

The title.

◆  GetTitle()

Gets the title of the dialog window.

返回

The title

◆  Enable()

Enables or disables the dialog item with the specified id .

参数

[in]	id	The control ID.
[in]	enabled	true to enable and false to disable.

返回

true if successful, otherwise false .

◆  IsEnabled()

Checks if a dialog item is enabled.

参数

[in]

id

The control ID.

返回

true if the dialog item is enabled, otherwise false .

◆  GetInputState()

Polls a certain channel of a device for the current input state.
If the return value is true , the container stored in res is like an input event message, otherwise no state was available.
For a list of valid devices and channels, see Input Events .

参数

[in]	askdevice	The device to ask.
[in]	askchannel	The channel of the device.
[out]	res	The result container.

返回

true if an input state could be retrieved, otherwise false .

◆  GetInputEvent()

Gets the next input event for a certain device from the event queue.
If the return value is true , the container stored in res is like an input event message, otherwise no state was available.
For a list of valid devices and channels, see Input Events .

参数

[in]	askdevice	The device to poll.
[out]	res	The result container.

返回

true if an input event could be retrieved, otherwise false .

◆  KillEvents()

Flushes all events from the window message queue.
For example if looping while the mouse is down (polling), call this function to flush all key downs/mouse clicks that are made during the loop.

◆  SetBool() [1/3]

Sets the value of checkbox controls.

参数

[in]	id	The control ID.
[in]	value	The new value. Checked is true and unchecked is false 。若 tristate is true then value must be 2 .
[in]	tristate	若 true ，和 value is 2 , the control is tinted to indicate tristate mode.

返回

true if the value was set, otherwise false .

◆  SetInt32() [1/3]

Sets the value and limits of integer fields. Also used for tab groups, radio buttons and combo boxes.

参数

[in]	id	The control ID.
[in]	value	The new value.
[in]	min	The minimum visual value accepted.
[in]	max	The maximum visual value accepted.
[in]	step	The step used for arrow buttons.
[in]	tristate	若 true the control is tinted to indicate tristate mode.
[in]	min2	The minimum value allowed outside the visual range used for sliders. Overrides min for the acceptance check.
[in]	max2	The maximum value allowed outside the visual range used for sliders. Overrides max for the acceptance check.

返回

true if the value was set, otherwise false .

◆  SetFloat() [1/3]

Sets the value, unit and limits of float fields.

参数

[in]	id	The control ID.
[in]	value	The new value.
[in]	min	The minimum visual value accepted.
[in]	max	The maximum visual value accepted.
[in]	step	The step used for arrow buttons.
[in]	format	The unit and format of the field: FORMAT_NUMBERS
[in]	min2	The minimum value allowed outside the visual range used for sliders. Overrides min for the acceptance check.
[in]	max2	The maximum value allowed outside the visual range used for sliders. Overrides max for the acceptance check.
[in]	quadscale	若 true a quadratic scale is used for the slider, so that more precision is available for lower values.
[in]	tristate	若 true the control is tinted to indicate tristate mode.

返回

true if the value was set, otherwise false .

◆  SetMeter() [1/3]

Sets the value and limits of a meter field. Same as SetFloat with FORMAT_METER .

参数

[in]	id	The control ID.
[in]	value	The new value.
[in]	min	The minimum value accepted.
[in]	max	The maximum value accepted.
[in]	step	The step used for arrow buttons.
[in]	tristate	若 true the control is tinted to indicate tristate mode.

返回

true if the value was set, otherwise false .

◆  SetDegree() [1/3]

Sets the value and limits of an angle field. Same as SetFloat with FORMAT_DEGREE .

参数

[in]	id	The control ID.
[in]	radians_value	The new angle in radians.
[in]	min	The minimum angle accepted in degrees.
[in]	max	The maximum angle accepted in degrees.
[in]	step	The step used for arrow buttons in degrees.
[in]	tristate	若 true the control is tinted to indicate tristate mode.

返回

true if the value was set, otherwise false .

◆  SetPercent() [1/3]

Sets the value and limits of a percent field. Same as SetFloat with FORMAT_PERCENT .

参数

[in]	id	The control ID.
[in]	value	The new value (real fraction).
[in]	min	The minimum value accepted (percentage units).
[in]	max	The maximum value accepted (percentage units).
[in]	step	The step used for arrow buttons (percentage units).
[in]	tristate	若 true the control is tinted to indicate tristate mode.

返回

true if the value was set, otherwise false .

◆  SetTime() [1/3]

Sets the value and limits of a time field. Same as SetFloat with FORMAT_FRAMES .

参数

[in]	id	The control ID.
[in]	doc	The document to be used for framerate calculations.
[in]	value	The new time value.
[in]	min	The minimum time accepted.
[in]	max	The maximum time accepted.
[in]	stepframes	The frame step used for arrow buttons.
[in]	tristate	若 true the control is tinted to indicate tristate mode.

返回

true if the value was set, otherwise false .

◆  SetString() [1/3]

Sets the text of string controls. Used for all controls that have a text, for example static text fields, edit fields, buttons and check boxes.

参数

[in]	id	The control ID.
[in]	text	The new text.
[in]	tristate	若 true the control is tinted to indicate tristate mode.
[in]	flags	Flags: EDITTEXT FLAG_CENTER_ALIGN

返回

true if the text was set, otherwise false .

◆  SetColorField() [1/2]

Sets the color, brightness and limits of color fields and color choosers.

警告

flags does not apply to color fields, only to color choosers.

参数

[in]	id	The control ID.
[in]	color	The new color value.
[in]	brightness	The new brightness value.
[in]	maxbrightness	The maximum brightness allowed.
[in]	flags	Controls what parts of a color chooser are available: DR_COLORFIELD

返回

true if the color field values were set, otherwise false .

◆  SetFilename() [1/2]

Sets the text of string controls, taking the new value from a filename.

参数

[in]	id	The control ID.
[in]	fn	The new filename.
[in]	tristate	若 true the control is tinted to indicate tristate mode.

返回

true if the filename was set, otherwise false .

◆  GetBool() [1/2]

Retrieves the state of checkbox controls.

参数

[in]	id	The control ID.
[out]	value	Assigned the current state.

返回

true if the state was retrieved, otherwise false .

◆  GetInt32() [1/2]

Retrieves the value of integer fields. Also used for tab groups, radio buttons and combo boxes.

参数

[in]	id	The control ID.
[out]	value	Assigned the current value.

返回

true if the value was retrieved, otherwise false .

◆  GetFloat() [1/2]

Retrieves the value of float fields.

参数

[in]	id	The control ID.
[out]	value	Assigned the current value.

返回

true if the value was retrieved, otherwise false .

◆  GetVector() [1/2]

Retrieves the value of three float fields at the same time as a vector.

参数

[in]	id_x	The control ID of the X field.
[in]	id_y	The control ID of the Y field.
[in]	id_z	The control ID of the Z field.
[out]	value	Assigned the current value.

返回

true if the value was retrieved, otherwise false .

◆  GetString() [1/2]

Retrieves the text from string controls. Used for all controls that have a text, for example static text fields, edit fields, buttons and check boxes.

参数

[in]	id	The control ID.
[out]	text	Assigned the current text.

返回

true if the text was retrieved, otherwise false .

◆  GetColorField() [1/2]

Retrieves the color and brightness of color controls.

参数

[in]	id	The control ID.
[out]	color	Assigned the current color.
[out]	brightness	Assigned the current brightness.

返回

true if the color field values were retrieved, otherwise false .

◆  GetTime() [1/2]

Retrieves the time of time fields.

参数

[in]	id	The control ID.
[in]	doc	The document to use for framerate calculations.
[out]	time	Assigned the current time.

返回

true if the time was retrieved, otherwise false .

◆  GetFilename() [1/2]

Retrieves the text from string controls as a filename.

参数

[in]	id	The control ID.
[out]	fn	Assigned the current filename.

返回

true if the value was retrieved, otherwise false .

◆  CheckTristateChange()

Checks if a control content has been changed since the last Set .

参数

[in]

id

The control ID.

返回

true if the control has been changed, otherwise false .

◆  SetBool() [2/3]

Sets the value of checkbox controls, taking the new value from a base container.

参数

[in]	id	The control ID.
[in]	bc	The base container with the new value. The caller owns the pointed base container.
[in]	bcid	The container ID of the new value.

返回

true if the value was set, otherwise false .

◆  SetInt32() [2/3]

Sets the value and limits of integer fields, taking the new value from a base container. Also used for tab groups, radio buttons and combo boxes.

参数

[in]	id	The control ID.
[in]	bc	The base container with the new value. The caller owns the pointed base container.
[in]	bcid	The container ID of the new value.
[in]	min	The minimum visual value accepted.
[in]	max	The maximum visual value accepted.
[in]	step	The step used for arrow buttons.
[in]	min2	The minimum value allowed outside the visual range used for sliders. Overrides min for the acceptance check.
[in]	max2	The maximum value allowed outside the visual range used for sliders. Overrides max for the acceptance check.

返回

true if the value was set, otherwise false .

◆  SetFloat() [2/3]

Sets the value, unit and limits of float fields, taking the new value from a base container.

参数

[in]	id	The control ID.
[in]	bc	The base container with the new value. The caller owns the pointed base container.
[in]	bcid	The container ID of the new value.
[in]	min	The minimum visual value accepted.
[in]	max	The maximum visual value accepted.
[in]	step	The step used for arrow buttons.
[in]	format	The unit and format of the field: FORMAT_NUMBERS
[in]	min2	The minimum value allowed outside the visual range used for sliders. Overrides min for the acceptance check.
[in]	max2	The maximum value allowed outside the visual range used for sliders. Overrides max for the acceptance check.
[in]	quadscale	若 true a quadratic scale is used for the slider, so that more precision is available for lower values.

返回

true if the value was set, otherwise false .

◆  SetMeter() [2/3]

Sets the value, unit and limits of meter fields, taking the new value from a base container. Same as SetFloat with FORMAT_METER .

参数

[in]	id	The control ID.
[in]	bc	The base container with the new value. The caller owns the pointed base container.
[in]	bcid	The container ID of the new value.
[in]	min	The minimum value accepted.
[in]	max	The maximum value accepted.
[in]	step	The step used for arrow buttons.

返回

true if the value was set, otherwise false .

◆  SetDegree() [2/3]

Sets the value, unit and limits of angle fields, taking the new value from a base container. Same as SetFloat with FORMAT_DEGREE .

参数

[in]	id	The control ID.
[in]	bc	The base container with the new value. The caller owns the pointed base container.
[in]	bcid	The container ID of the new value.
[in]	min	The minimum value accepted.
[in]	max	The maximum value accepted.
[in]	step	The step used for arrow buttons.

返回

true if the value was set, otherwise false .

◆  SetPercent() [2/3]

Sets the value, unit and limits of percent fields, taking the new value from a base container. Same as SetFloat with FORMAT_PERCENT .

参数

[in]	id	The control ID.
[in]	bc	The base container with the new value (real fraction). The caller owns the pointed base container.
[in]	bcid	The container ID of the new value.
[in]	min	The minimum value accepted.
[in]	max	The maximum value accepted.
[in]	step	The step used for arrow buttons.

返回

true if the value was set, otherwise false .

◆  SetTime() [2/3]

Sets the value and limits of a time field, taking the new value from a base container. Same as SetFloat with FORMAT_FRAMES .

参数

[in]	id	The control ID.
[in]	doc	The document to get the framerate from. The caller owns the pointed document.
[in]	bc	The base container with the new time. The caller owns the pointed base container.
[in]	bcid	The container ID of the new time.
[in]	min	The minimum value accepted.
[in]	max	The maximum value accepted.
[in]	stepframes	The frame step used for arrow buttons.

返回

true if the time was set, otherwise false .

◆  SetString() [2/3]

Sets the text of string controls, taking the new value from a base container. Used for all controls that have a text, for example static text fields, edit fields, buttons and check boxes.

参数

[in]	id	The control ID.
[in]	bc	The base container with the new value. The caller owns the pointed base container.
[in]	bcid	The container ID of the new value.
[in]	flags	Flags: EDITTEXT FLAG_CENTER_ALIGN

返回

true if the value was set, otherwise false .

◆  SetFilename() [2/2]

Sets the text of string controls, taking the new value from a filename in a base container.

参数

[in]	id	The control ID.
[in]	bc	The base container with the new value. The caller owns the pointed base container.
[in]	bcid	The container ID of the new value.

返回

true if the value was set, otherwise false .

◆  SetColorField() [2/2]

Sets the color, brightness and limits of color fields and color choosers, taking the new values from a base container.

参数

[in]	id	The control ID.
[in]	bc	The base container with the new color field values. The caller owns the pointed base container.
[in]	bc_colid	The container ID of the new color value.
[in]	bc_brightnessid	The container ID of the new brightness value.
[in]	maxbrightness	The maximum brightness allowed.
[in]	flags	Controls what parts of a color chooser are available: DR_COLORFIELD

返回

true if the color field values were set, otherwise false .

◆  GetBool() [2/2]

Retrieves the state of checkbox controls, and stores it in a base container.

参数

[in]	id	The control ID.
[out]	bc	The base container to receive the state. The caller owns the pointed base container.
[in]	bcid	The container ID of the state.

返回

true if the value was retrieved, otherwise false .

◆  GetInt32() [2/2]

Retrieves the value of integer fields, and stores it in a base container. Also used for tab groups, radio buttons and combo boxes.

参数

[in]	id	The control ID.
[out]	bc	The base container to receive the value. The caller owns the pointed base container.
[in]	bcid	The container ID of the value.

返回

true if the value was retrieved, otherwise false .

◆  GetFloat() [2/2]

Retrieves the value of float fields, and stores it in a base container.

参数

[in]	id	The control ID.
[out]	bc	The base container to receive the value. The caller owns the pointed base container.
[in]	bcid	The container ID of the value.

返回

true if the value was retrieved, otherwise false .

◆  GetTime() [2/2]

Retrieves the value of a time field, and stores it in a base container.

参数

[in]	id	The control ID.
[in]	doc	The document to get the framerate from. The caller owns the pointed document.
[out]	bc	The base container to receive the value. The caller owns the pointed base container.
[in]	bcid	The container ID of the value.

返回

true if the value was retrieved, otherwise false .

◆  GetVector() [2/2]

Retrieves the value of three float fields at the same time as a vector, and stores it in a base container.

参数

[in]	id_x	The control ID of the X field.
[in]	id_y	The control ID of the Y field.
[in]	id_z	The control ID of the Z field.
[out]	bc	The base container to receive the value. The caller owns the pointed base container.
[in]	bcid	The container ID of the value.

返回

true if the value was retrieved, otherwise false .

◆  GetString() [2/2]

Retrieves the value from string controls, and stores it in a base container. Used for all controls that have a text, for example static text fields, edit fields, buttons and check boxes.

参数

[in]	id	The control ID.
[out]	bc	The base container to receive the value. The caller owns the pointed base container.
[in]	bcid	The container ID of the value.

返回

true if the value was retrieved, otherwise false .

◆  GetFilename() [2/2]

Retrieves the value from string controls, and stores it as a filename in a base container.

参数

[in]	id	The control ID.
[out]	bc	The base container to receive the value. The caller owns the pointed base container.
[in]	bcid	The container ID of the value.

返回

true if the value was retrieved, otherwise false .

◆  GetColorField() [2/2]

Retrieves the values of color and brightness for color controls, and stores them in a base container.

参数

[in]	id	The control ID.
[out]	bc	The base container to receive the values. The caller owns the pointed base container.
[in]	bc_colid	The container ID of the color value.
[in]	bc_brightnessid	The container ID of the brightness value.

返回

true if the values were retrieved, otherwise false .

◆  SetBool() [3/3]

Sets the value of checkbox controls using a TriState 对象。

参数

[in]	id	The control ID.
[in]	tri	A tristate object for the value.

返回

true if the value was set, otherwise false .

◆  SetInt32() [3/3]

Sets the value and limits of integer fields using a TriState 对象。

参数

[in]	id	The control ID.
[in]	tri	A tristate object for the value.
[in]	min	The minimum visual value accepted.
[in]	max	The maximum visual value accepted.
[in]	step	The step used for arrow buttons.
[in]	min2	The minimum value allowed outside the visual range used for sliders. Overrides min for the acceptance check.
[in]	max2	The maximum value allowed outside the visual range used for sliders. Overrides max for the acceptance check.

返回

true if the value was set, otherwise false .

◆  SetFloat() [3/3]

Sets the value, unit and limits of float fields using a TriState 对象。

参数

[in]	id	The control ID.
[in]	tri	A tristate object for the value.
[in]	min	The minimum visual value accepted.
[in]	max	The maximum visual value accepted.
[in]	step	The step used for arrow buttons.
[in]	format	The unit and format of the field: FORMAT_NUMBERS
[in]	min2	The minimum value allowed outside the visual range used for sliders. Overrides min for the acceptance check.
[in]	max2	The maximum value allowed outside the visual range used for sliders. Overrides max for the acceptance check.
[in]	quadscale	若 true a quadratic scale is used for the slider, so that more precision is available for lower values.

返回

true if the value was set, otherwise false .

◆  SetMeter() [3/3]

Sets the value and limits of a meter field using a TriState object. Same as SetFloat with FORMAT_METER .

参数

[in]	id	The control ID.
[in]	tri	A tristate object for the value.
[in]	min	The minimum visual value accepted.
[in]	max	The maximum visual value accepted.
[in]	step	The step used for arrow buttons.

返回

true if the value was set, otherwise false .

◆  SetDegree() [3/3]

Sets the value and limits of an angle field using a TriState object. Same as SetFloat with FORMAT_DEGREE .

参数

[in]	id	The control ID.
[in]	tri	A tristate object for the value.
[in]	min	The minimum visual value accepted.
[in]	max	The maximum visual value accepted.
[in]	step	The step used for arrow buttons.

返回

true if the value was set, otherwise false .

◆  SetPercent() [3/3]

Sets the value and limits of a percent field using a TriState object. Same as SetFloat with FORMAT_PERCENT .

参数

[in]	id	The control ID.
[in]	tri	A tristate object for the value.
[in]	min	The minimum visual value accepted.
[in]	max	The maximum visual value accepted.
[in]	step	The step used for arrow buttons.

返回

true if the value was set, otherwise false .

◆  SetTime() [3/3]

Sets the value and limits of a time field using a TriState object. Same as SetFloat with FORMAT_FRAMES .

参数

[in]	id	The control ID.
[in]	doc	The document to be used for framerate calculations.
[in]	tri	A tristate object for the value.
[in]	min	The minimum time accepted.
[in]	max	The maximum time accepted.
[in]	stepframes	The frame step used for arrow buttons.

返回

true if the value was set, otherwise false .

◆  SetString() [3/3]

Sets the text of string controls using a TriState 对象。

参数

[in]	id	The control ID.
[in]	tri	A tristate object for the value.
[in]	flags	Flags: EDITTEXT FLAG_CENTER_ALIGN

返回

true if the value was set, otherwise false .

◆  Local2Global()

Transforms local coordinates (relative to the top left corner of the user area) to global window coordinates (relative to the top left corner of the application window). Stores the result in * x and * y .

参数

[in,out]	x	The local X coordinate. Assigned the global window coordinate.
[in,out]	y	The local Y coordinate. Assigned the global window coordinate.

返回

true if the coordinates were converted, otherwise false .

◆  Global2Local()

Transforms global window coordinates (relative to the top left corner of the application window) to local coordinates (relative to the top left corner of the user area). Stores the result in * x and * y .

参数

[in,out]	x	The global window X coordinate. Assigned the local coordinate.
[in,out]	y	The global window Y coordinate. Assigned the local coordinate.

返回

true if the coordinates were converted, otherwise false .

◆  Screen2Local()

Transforms screen coordinates (relative to the top left corner of the system screen) to local coordinates (relative to the top left corner of the user area). Stores the result in * x and * y .

参数

[in,out]	x	The screen X coordinate. Assigned the local coordinate.
[in,out]	y	The screen Y coordinate. Assigned the local coordinate.

返回

true if the coordinates were converted, otherwise false .

◆  Local2Screen()

Transforms local coordinates (relative to the top left corner of the user area) to screen coordinates (relative to the top left corner of the system screen). Stores the result in * x and * y .

参数

[in,out]	x	The local X coordinate. Assigned the screen coordinate.
[in,out]	y	The local Y coordinate. Assigned the screen coordinate.

返回

true if the coordinates were converted, otherwise false .

◆  GetColorRGB()

Gets the RGB values associated with a color constant.

参数

[in]	colorid	A color constant: COLOR
[out]	r	Assigned the red component of the color.
[out]	g	Assigned the green component of the color.
[out]	b	Assigned the blue component of the color.

返回

true if successful, otherwise false .

◆  SetDefaultColor() [1/2]

Sets the default color for GUI elements.

参数

[in]	id	The control ID to set the color for.
[in]	colorid	A color constant: COLOR
[in]	mapid	The color map ID.

◆  SetDefaultColor() [2/2]

Sets the default color for GUI elements.

参数

[in]	id	The control ID to set the color for.
[in]	colorid	A color constant: COLOR
[in]	color	The color to set.

◆  LoadDialogResource()

Loads an external resource file.
This is the preferred method for dialog layout since it gives maximum flexibility and easy multi language support.

注意

The dialog loaded is automatically surrounded by an additional outer group, so flags means the same as with dialog groups (e.g. BFV_CENTER ). See Dialog Resource 了解更多信息。

参数

[in]	id	The dialog ID.
[in]	lr	The loaded resource or nullptr . If this is nullptr then the global ::resource singleton is used. The caller owns the pointed resource.
[in]	flags	The layout flags: BFH BFV

返回

true if the dialog was loaded successfully, otherwise false .

◆  AddCheckbox()

Adds a checkbox to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	name	The name of the checkbox.

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddButton()

Adds a button to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	name	The name of the button.

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddStaticText()

Adds a static text to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	name	The name of the static text.
[in]	borderstyle	The border style: BORDER

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddArrowButton()

Adds an arrow button to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	arrowtype	The arrow type: ARROW

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddEditText()

Adds an editable text field to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	editflags	The edit flags: EDITTEXT

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddMultiLineEditText()

Adds an editable text field with multiple lines to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	style	The style flags: DR_MULTILINE

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddEditNumber()

Adds an editable number field to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddEditNumberArrows()

Adds an editable number field with up/down arrows to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddEditSlider()

Adds a slider with an editable number field to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddSlider()

Adds a slider to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddColorField()

Adds a simple color field without sliders to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	colorflags	The color flags: DR_COLORFIELD

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddColorChooser()

Adds a color chooser gadget to the layout.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	layoutflags	The color flags: DR_COLORFIELD
[in]	settings	The color chooser settings. 由于 R17

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddRadioButton()

Adds a radio button to the layout. Used with radio groups created with AddRadioGroup() .

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	name	The name of the radio button.

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddRadioText()

Adds a text radio button to the layout (like the ones to the left in the Material Editor). Used with radio groups created with AddRadioGroup() .

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	name	The name of the text radio button.

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddEditShortcut()

Adds a field for editing shortcuts.

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	shortcutflags	The shortcut flags.

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddSeparatorH()

Adds a horizontal separator to the layout.

参数

[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	flags	The layout flags: BFH BFV

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddSeparatorV()

Adds a vertical separator to the layout.

参数

[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	flags	The layout flags: BFH BFV

返回

The added gadget, or nullptr if an error occurred. The dialog owns the pointed gadget.

◆  AddRadioGroup()

Adds a radio group to the layout. To add items to the radio button group use the AddChild() 函数。

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	columns	The number of columns, or 0 if rows 被使用。
[in]	rows	The number of rows, or 0 if columns 被使用。

返回

true if the radio group was added, otherwise false .

◆  AddComboBox()

Adds a combo box to the layout. To add items to the combo box menu use the AddChild() 函数。

参数

[in]	id	The control ID.
[in]	flags	The layout flags: BFH BFV
[in]	initw	The initial width. Use SizePixChr() to set this value.
[in]	inith	The initial height. Use SizePixChr() to set this value.
[in]	specialalign	Used to quantize the width of the combo box. If this is true then the width of the combo box will be a multiple of initw . For example if initw is 60px and specialalign is true the width will be 60 , 120 , 180px and so on.
[in]	allowFiltering	True to allow keyboard filtering of the combobox list.