类参考

DreamGUI 每个公开类的属性、函数与事件，由反射生成，并附与 UMG 的对照。

这里每一页对应一个类：它的属性（类型、分类、是否出现在细节面板、蓝图怎么读写）、可调用的函数、事件，以及页尾和对应 UMG 类的命名对照。页面由插件的 DreamGUIReferenceDocs commandlet 从反射打印出来，所以永远不会落后于头文件：

UnrealEditor-Cmd.exe <project>.uproject -run=DreamGUIReferenceDocs

命名为什么和 UMG 一致、哪些成员刻意不同，见与 UMG 的命名对照。

控件


`UDreamBorder`	A border whose hierarchy is code, not an asset: a face, a padding, and a hole to put things in.
`UDreamButton`	A button whose hierarchy is code, not an asset.
`UDreamDialog`	A dialog whose hierarchy is code, not an asset: a dimmer, a centred panel, a title, a content
`UDreamDropdown`	A dropdown whose hierarchy is code, not an asset.
`UDreamEditableText`	A text field with no box: UMG's EditableText, where Native.TextInput is its EditableTextBox.
`UDreamExpandableArea`	A header that toggles, and the content it hides.
`UDreamInputKeySelector`	A button whose label is a bound key, and which listens for the next one when clicked.
`UDreamListView`	A list whose hierarchy is code, not an asset: rows built from a source, in a scrolling viewport.
`UDreamListViewBase`	Everything a list and a tree have in common, which is nearly all of it.
`UDreamMenuAnchor`	A place a menu opens from, and the thing that puts it away again.
`UDreamMultiLineEditableText`	The same field over several lines: UMG's MultiLineEditableText.
`UDreamNativeWidgetHost`	A hole in a DreamGUI hierarchy that a UMG widget fills.
`UDreamProgressBar`	A progress bar whose hierarchy is code, not an asset.
`UDreamRadioButton`	A radio button whose hierarchy is code, not an asset.
`UDreamRichTextBlock`	A rich text block whose hierarchy is code, not an asset: one paragraph that reads markup.
`UDreamRingMenu`	A ring menu whose hierarchy is code, not an asset: wedges around a hub, picked by direction.
`UDreamScrollBar`	A scroll bar whose hierarchy is code, not an asset.
`UDreamScrollBox`	A scroll box whose hierarchy is code, not an asset.
`UDreamSlider`	A slider whose hierarchy is code, not an asset.
`UDreamSpinBox`	A spin box whose hierarchy is code, not an asset.
`UDreamTabView`	A tab view whose hierarchy is code, not an asset: a strip of tabs over a switcher of pages.
`UDreamTextInput`	A text field whose hierarchy is code, not an asset.
`UDreamThrobber`	A throbber whose hierarchy is code, not an asset: N pieces that pulse, saying only "something is
`UDreamTileView`	A tile view whose hierarchy is code, not an asset: a list whose rows are laid out across as well
`UDreamToggle`	A toggle whose hierarchy is code, not an asset.
`UDreamTreeView`	A tree whose hierarchy is code, not an asset: a list whose rows carry an indent and a twisty.
`UDreamUIControl`	A control whose hierarchy is code, not an asset.

面板与插槽


`UDreamLayoutContainerBorder`	UMG's UBorder: one child, padded, aligned by the BORDER rather than by the child's slot.
`UDreamLayoutContainerCanvasPanel`	UMG Canvas Panel
`UDreamLayoutContainerGridPanel`	UMG Grid Panel
`UDreamLayoutContainerHorizontalBox`	UMG Horizontal Box
`UDreamLayoutContainerMenuAnchor`	UMG's UMenuAnchor, layout side.
`UDreamLayoutContainerOverlay`	UMG Overlay
`UDreamLayoutContainerSafeZone`	UMG Safe Zone
`UDreamLayoutContainerScaleBox`	UMG Scale Box
`UDreamLayoutContainerScrollBox`	UMG Scroll Box
`UDreamLayoutContainerSizeBox`	UMG Size Box
`UDreamLayoutContainerStackBox`	UMG Stack Box
`UDreamLayoutContainerUniformGridPanel`	UMG Uniform Grid Panel
`UDreamLayoutContainerVerticalBox`	UMG Vertical Box
`UDreamLayoutContainerWidgetSwitcher`	UMG Widget Switcher
`UDreamLayoutContainerWrapBox`	UMG Wrap Box
`UDreamPanelLayoutBase`	Dream Panel Layout Base
`UDreamPanelSlot`	UMG-style per-child layout data owned by the child widget.

控件基类与用户控件


`UDreamUserWidget`	A widget hierarchy that is a CLASS rather than an asset instance -- the counterpart to UMG's
`UDreamWidget`	Base class for almost all UI related things.

函数库


`UDreamLyricsLibrary`	Dream Lyrics Library
`UDreamTextPaintLibrary`	Tweens that move a text's paints (FDreamTextPaint) without repainting it: each drives one of UDreamText's paint
`UDreamUIAnimationLibrary`	The Blueprint-side helpers for FDreamUIAnimationHandle, which a struct cannot carry itself.
`UDreamUIBPLibrary`	Dream UIBPLibrary
`UDreamUICaptureLibrary`	Pictures of what DreamGUI draws, written out as PNG files -- a render target, a canvas that renders into one, or a
`UDreamUIInputModeLibrary`	Input mode and cursor control, addressed by DreamGUI's user index rather than by a raw controller.
`UDreamUILayoutLibrary`	The viewport, the mouse and the screen -- this framework's UWidgetLayoutLibrary.
`UDreamUIWidgetGeometryLibrary`	Coordinate conversions between a widget's own space, the viewport and the screen -- this
`UDreamUIWidgetLibrary`	Finding widgets, driving a drag, and building an image brush from Blueprint -- the parts of

样式


`FDreamBorderStyle`	A border: a brush, a padding and one child.
`FDreamButtonStyle`	A button: one face, three pointer states, a label.
`FDreamDialogStyle`	A dialog: a dimmer over the screen, a panel on it, a title, content and buttons.
`FDreamDropdownStyle`	A dropdown: a button-shaped face, and the list it opens.
`FDreamExpandableAreaStyle`	An expandable area: a header that toggles, and the content it hides.
`FDreamInputKeySelectorStyle`	A key binder: a button whose label is the bound key, and which listens when pressed.
`FDreamListStyle`	A list: rows built from a source, in a scrolling viewport.
`FDreamMenuAnchorStyle`	A menu anchor: the popup's look, and how it is placed against whatever opened it.
`FDreamProgressBarStyle`	A progress bar: a track and the filled part of it.
`FDreamRadioButtonStyle`	A radio button: the toggle's anatomy -- a box, a mark inside it, a label beside it -- with the
`FDreamRichTextStyle`	A rich text block: one paragraph that reads markup.
`FDreamRingMenuStyle`	A ring menu: wedges around a hub, and the geometry that decides where they sit.
`FDreamScrollBarStyle`	A scroll box: a clipped viewport, the content that slides inside it, and the bars beside it.
`FDreamScrollBoxStyle`	Dream Scroll Box Style
`FDreamSliderStyle`	A slider: a track, the filled part of it, and the handle riding it.
`FDreamSpinBoxStyle`	A spin box: a numeric field between a decrement face and an increment face.
`FDreamTabViewStyle`	A tab view: a strip of tabs over a switcher of pages.
`FDreamTextInputStyle`	A text field: the box, the text in it, and the placeholder shown while there is none.
`FDreamTextStyle`	How the built-in shader draws a text's glyphs beyond the plain face: outline, underlay (drop
`FDreamThrobberStyle`	A throbber: N identical pieces, animating, saying only "something is happening".
`FDreamTileViewStyle`	A tile view: a list whose rows are a grid of tiles.
`FDreamToggleStyle`	What a toggle looks like, separated from what it is.
`FDreamTreeViewStyle`	A tree: a list whose rows carry an indent and a twisty.
`FDreamUIFaceBrush`	An optional skin for a control part's procedural-rect face.
`FDreamUIImageBrush`	Dream UIImage Brush
`FDreamUIStateFaces`	One face drawn five ways -- Slate's FButtonStyle shape, which is the thing a control style here
`FDreamUIWidgetGeometry`	A widget's measured rect, and the handle every coordinate conversion below is asked through --

控件

面板与插槽

控件基类与用户控件

函数库

样式

本页目录