FDetailsViewArgs

Init params for a details view widget

Choose your operating system:

Windows

macOS

Linux

References

Module

PropertyEditor

Header

/Engine/Source/Editor/PropertyEditor/Public/DetailsViewArgs.h

Include

#include "DetailsViewArgs.h"

Syntax

struct FDetailsViewArgs

Remarks

Init params for a details view widget

Variables

Name Description

Public variable

bool: 1

 

bAllowFavoriteSystem

If false, the current properties editor will never display the favorite system

Public variable

bool: 1

 

bAllowMultipleTopLevelObjects

If true the details panel will assume each object passed in through SetObjects will be a unique object shown in the tree and not combined with other objects

Public variable

bool: 1

 

bAllowSearch

True if we allow searching

Public variable

bool: 1

 

bCustomFilterAreaLocation

If true, the filter area will be created but will not be displayed so it can be placed in a custom location.

Public variable

bool: 1

 

bCustomNameAreaLocation

If true, the name area will be created but will not be displayed so it can be placed in a custom location.

Public variable

bool: 1

 

bForceHiddenPropertyVisibility

If true, all properties will be visible, not just those with CPF_Edit

Public variable

bool: 1

 

bHideSelectionTip

True if you want to not show the tip when no objects are selected (should only be used if viewing actors properties or bObjectsUseNameArea is true )

Public variable

bool: 1

 

bLockable

True if this property view can be locked

Public variable

bool: 1

 

bSearchInitialKeyFocus

True if you want the search box to have initial keyboard focus

Public variable

bool: 1

 

bShowAnimatedPropertiesOption

True if you want to show the 'Show Only Animated Properties'.

Public variable

bool: 1

 

bShowCustomFilterOption

True if you want to show a custom filter.

Public variable

bool: 1

 

bShowDifferingPropertiesOption

True if you want to show the 'Show Only Differing Properties' option.

Public variable

bool: 1

 

bShowHiddenPropertiesWhilePlayingOption

True if you want to show the 'Show Hidden Properties While Playing' option.

Public variable

bool: 1

 

bShowKeyablePropertiesOption

True if you want to show the 'Show Only Keyable Properties'.

Public variable

bool: 1

 

bShowModifiedPropertiesOption

True if you want to show the 'Show Only Modified Properties' option.

Public variable

bool: 1

 

bShowObjectLabel

True if you want to show the object label

Public variable

bool: 1

 

bShowOptions

Allow options to be changed

Public variable

bool: 1

 

bShowPropertyMatrixButton

True if the 'Open Selection in Property Matrix' button should be shown

Public variable

bool: 1

 

bShowScrollBar

If false, the details panel's scrollbar will always be hidden.

Public variable

bool: 1

 

bShowSectionSelector

True if the section selector should be shown.

Public variable

bool: 1

 

bUpdatesFromSelection

True if the viewed objects updates from editor selection

Public variable

TArray< TShared...

 

ClassViewerFilters

Optional custom filter(s) to apply to the class viewer widget for class object property values.

Public variable

float

 

ColumnWidth

The default value column width, as a percentage, 0-1.

Public variable

EEditDefaultsOn...

 

DefaultsOnlyVisibility

Controls how CPF_DisableEditOnInstance nodes will be treated

Public variable

TSharedPtr< cla...

 

HostCommandList

The command list from the host of the details view, allowing child widgets to bind actions with a bound chord

Public variable

TSharedPtr< cla...

 

HostTabManager

The tab manager from the host of the details view, allowing child widgets to spawn tabs

Public variable

int32

 

NameAreaSettings

Settings for displaying the name area (

Public variable

FNotifyHook ...

 

NotifyHook

Notify hook to call when properties are changed

Public variable

TSharedPtr< cla...

 

ObjectFilter

Optional object filter to use for more complex handling of what a details panel is viewing.

Public variable

float

 

RightColumnMinWidth

The minimum width of the right column in Slate units.

Public variable

FName

 

ViewIdentifier

Identifier for this details view; NAME_None if this view is anonymous

Constructors

Name Description

Public function

FDetailsViewArgs()

Public function

FDetailsViewArgs

(
    const FDetailsViewArgs&
)

Public function

FDetailsViewArgs

(
    const bool InUpdateFromSelection,
    const bool InLockable,
    const bool InAllowSearch,
    const ENameAreaSettings InNameAreaS...,
    const bool InHideSelectionTip,
    FNotifyHook* InNotifyHook,
    const bool InSearchInitialKeyFocus,
    FName InViewIdentifier
)

This constructor is deprecated, please create an empty FDetailsViewArgs and explicitly set any values that you wish to change.

Operators

Name Description

Public function

FDetailsView...

 

operator=

(
    const FDetailsViewArgs&
)

Enums

Name

Description

Public enum

ENameAreaSettings

Deprecated Variables

Name Description

Public variable

bool: 1

 

bShowActorLabel

bShowActorLabel has been renamed bShowObjectLabel

Deprecated Functions

Name Description

Public function

 

FDetailsViewArgs

(
    const bool InUpdateFromSelection,
    const bool InLockable,
    const bool InAllowSearch,
    const ENameAreaSettings InNameAreaS...,
    const bool InHideSelectionTip,
    FNotifyHook* InNotifyHook,
    const bool InSearchInitialKeyFocus,
    FName InViewIdentifier
)

This constructor is deprecated, please create an empty FDetailsViewArgs and explicitly set any values that you wish to change.