Navigation
API > API/Plugins > API/Plugins/DMXProtocolEditor
A widget that allows to select a DMX port available in from the DMXPortManager.
Directly returns corresponding DMXPort via the GetPort method.
| Name | SDMXPortSelector |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocolEditor/Public/Widgets/SDMXPortSelector.h |
| Include Path | #include "Widgets/SDMXPortSelector.h" |
Syntax
class SDMXPortSelector : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SDMXPortSelector
- FSlateControlledConstruction → SWidget → SCompoundWidget → SDMXPortSelector
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SDMXPortSelector() |
Widgets/SDMXPortSelector.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasMultipleValues | bool | State where the widget was set to have multiple values | Widgets/SDMXPortSelector.h | |
| bIsUnderConstruction | bool | True during Construct, to avoid raising OnPortSelected while the widget is not valid yet | Widgets/SDMXPortSelector.h | |
| ComboBoxSource | TArray< TSharedPtr< FDMXPortSelectorItem > > | Array of Port Selector Items to serve as combo box source | Widgets/SDMXPortSelector.h | |
| ContentBorder | TSharedPtr< SBorder > | Border that holds all the arbitrary content, to switch content dynamically | Widgets/SDMXPortSelector.h | |
| Mode | EDMXPortSelectorMode | Defines which ports are shown | Widgets/SDMXPortSelector.h | |
| OnPortSelected | FSimpleDelegate | Widgets/SDMXPortSelector.h | ||
| PortNameComboBox | TSharedPtr< SComboBox< TSharedPtr< FDMXPortSelectorItem > > > | The combo box that holds all ports | Widgets/SDMXPortSelector.h | |
| PortNameTextBlock | TSharedPtr< STextBlock > | Text box shown on top of the Port Name Combo Box | Widgets/SDMXPortSelector.h | |
| RestoreItem | TSharedPtr< FDMXPortSelectorItem > | The last selected item. Use only to restore from selecting a category row. | Widgets/SDMXPortSelector.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Constructs the widget | Widgets/SDMXPortSelector.h | |
FDMXInputPortSharedPtr GetSelectedInputPort() |
Returns the selected input port, or nullptr if no valid input port is selected | Widgets/SDMXPortSelector.h | |
FDMXOutputPortSharedPtr GetSelectedOutputPort() |
Returns the selected output port, or nullptr if no valid output port is selected | Widgets/SDMXPortSelector.h | |
bool HasSelection() |
Returns true if a valid port is selected | Widgets/SDMXPortSelector.h | |
bool IsInputPortSelected() |
Returns true if an input port is selected | Widgets/SDMXPortSelector.h | |
bool IsOutputPortSelected() |
Returns true if an output port is selected | Widgets/SDMXPortSelector.h | |
void SelectPort
(
const FGuid& PortGuid |
Selects specified Port by Port Guid. If the Guid is not valid, clears the selection | Widgets/SDMXPortSelector.h | |
void SetHasMultipleValues () |
Instead of showing a selected port, the widget displays 'Multiple Values' and no longer returns a selected port. | Widgets/SDMXPortSelector.h |