FDetailsViewArgs

Init params for a details view widget

API > API/Editor > API/Editor/PropertyEditor

Init params for a details view widget

   
Name FDetailsViewArgs
Type struct
Header File /Engine/Source/Editor/PropertyEditor/Public/DetailsViewArgs.h
Include Path #include "DetailsViewArgs.h"

Syntax

struct FDetailsViewArgs

Constructors

Name Remarks Include Path Unreal Specifiers
  DetailsViewArgs.h  
  DetailsViewArgs.h  

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

 Default constructor DetailsViewArgs.h  

Enums

Public

Name Remarks
EExpansionPersistenceMethod Enum to set expansion persistence. Used to support saving expansion per details view.
ENameAreaSettings  

Typedefs

Name Type Remarks Include Path
FShouldForceHideProperty TBaseDelegate_OneParam< bool, const TSharedRef< IPropertyHandle > & > Delegate that determines whether a property should be forced hidden - evaluated on panel refresh DetailsViewArgs.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowFavoriteSystem bool If false, the current properties editor will never display the favorite system DetailsViewArgs.h  
bAllowMultipleTopLevelObjects bool 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 DetailsViewArgs.h  
bAllowSearch bool True if we allow searching DetailsViewArgs.h  
bCustomFilterAreaLocation bool If true, the filter area will be created but will not be displayed so it can be placed in a custom location. DetailsViewArgs.h  
bCustomNameAreaLocation bool If true, the name area will be created but will not be displayed so it can be placed in a custom location. DetailsViewArgs.h  
bForceHiddenPropertyVisibility bool If true, all properties will be visible, not just those with CPF_Edit DetailsViewArgs.h  
bHideSelectionTip bool 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 ) DetailsViewArgs.h  
bLockable bool True if this property view can be locked DetailsViewArgs.h  
bResolveInstanceDataObjects TOptional< bool > Resolve any UObject* to their IDO counterparts if they exist DetailsViewArgs.h  
bSearchInitialKeyFocus bool True if you want the search box to have initial keyboard focus DetailsViewArgs.h  
bShowActorLabel bool   DetailsViewArgs.h  
bShowAnimatedPropertiesOption bool True if you want to show the 'Show Only Animated Properties'. DetailsViewArgs.h  
bShowCustomFilterOption bool True if you want to show a custom filter. DetailsViewArgs.h  
bShowDifferingPropertiesOption bool True if you want to show the 'Show Only Differing Properties' option. DetailsViewArgs.h  
bShowHeaders bool Allow headers to be hidden DetailsViewArgs.h  
bShowHiddenPropertiesWhilePlayingOption bool True if you want to show the 'Show Hidden Properties While Playing' option. DetailsViewArgs.h  
bShowKeyablePropertiesOption bool True if you want to show the 'Show Only Keyable Properties'. DetailsViewArgs.h  
bShowLooseProperties bool If true, loose properties should be shown. DetailsViewArgs.h  
bShowModifiedPropertiesOption bool True if you want to show the 'Show Only Modified Properties' option. DetailsViewArgs.h  
bShowObjectLabel bool True if you want to show the object label DetailsViewArgs.h  
bShowOptions bool Allow options to be changed DetailsViewArgs.h  
bShowPropertyMatrixButton bool True if the 'Open Selection in Property Matrix' button should be shown DetailsViewArgs.h  
bShowScrollBar bool If false, the details panel's scrollbar will always be hidden. DetailsViewArgs.h  
bShowSectionSelector bool True if the section selector should be shown. DetailsViewArgs.h  
bUpdatesFromSelection bool True if the viewed objects updates from editor selection DetailsViewArgs.h  
ClassViewerFilters TArray< TSharedRef< IClassViewerFilter > > Optional custom filter(s) to apply to the class viewer widget for class object property values. DetailsViewArgs.h  
ColumnWidth float The default value column width, as a percentage, 0-1. DetailsViewArgs.h  
DefaultsOnlyVisibility EEditDefaultsOnlyNodeVisibility Controls how CPF_DisableEditOnInstance nodes will be treated DetailsViewArgs.h  
DetailsNameWidgetOverrideCustomization TSharedPtr< FDetailsNameWidgetOverrideCustomization > A Customization that can be applied to all name widgets DetailsViewArgs.h  
ExpansionPersistenceMethod EExpansionPersistenceMethod Persistence method for expansion in this details view DetailsViewArgs.h  
ExternalScrollbar TSharedPtr< SScrollBar > Externally constructed Scrollbar (internally constructed if not provided) DetailsViewArgs.h  
HostCommandList TSharedPtr< FUICommandList > The command list from the host of the details view, allowing child widgets to bind actions with a bound chord DetailsViewArgs.h  
HostTabManager TSharedPtr< FTabManager > The tab manager from the host of the details view, allowing child widgets to spawn tabs DetailsViewArgs.h  
InitialCategories TSet< FName > Initial categories to be shown enabled in the filter DetailsViewArgs.h  
InitialSections TSet< FName > Initial sections to be shown enabled in the filter DetailsViewArgs.h  
NameAreaSettings int32 Settings for displaying the name area ( DetailsViewArgs.h  
NotifyHook FNotifyHook * Notify hook to call when properties are changed DetailsViewArgs.h  
ObjectFilter TSharedPtr< FDetailsViewObjectFilter > Optional object filter to use for more complex handling of what a details panel is viewing. DetailsViewArgs.h  
OptionsExtender TSharedPtr< FExtender > If bShowOptions menu is available, adds support for user defined menu options DetailsViewArgs.h  
RightColumnMinWidth float The minimum width of the right column in Slate units. DetailsViewArgs.h  
ScrollbarAlignment EHorizontalAlignment Whether to display scrollbar on the left or the right of the panel DetailsViewArgs.h  
ShouldForceHideProperty FShouldForceHideProperty   DetailsViewArgs.h  
StyleKey TSharedPtr< FDetailsViewStyleKey > A TSharedPtr which provides the key to the Details View's style DetailsViewArgs.h  
ViewIdentifier FName Identifier for this details view; NAME_None if this view is anonymous DetailsViewArgs.h  

Functions

Public

Operators

Name Remarks Include Path Unreal Specifiers

FDetailsViewArgs & operator= ( const FDetailsViewArgs&
)

   DetailsViewArgs.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page