FExtender Class Reference

#include <MultiBoxExtender.h>

Public Member Functions
SLATE_API TSharedRef< const FExtensionBase >	AddMenuBarExtension (FName ExtensionHook, EExtensionHook::Position HookPosition, const TSharedPtr< FUICommandList > &CommandList, const FMenuBarExtensionDelegate &MenuBarExtensionDelegate)
SLATE_API TSharedRef< const FExtensionBase >	AddMenuExtension (FName ExtensionHook, EExtensionHook::Position HookPosition, const TSharedPtr< FUICommandList > &CommandList, const FMenuExtensionDelegate &MenuExtensionDelegate)
SLATE_API TSharedRef< const FExtensionBase >	AddToolBarExtension (FName ExtensionHook, EExtensionHook::Position HookPosition, const TSharedPtr< FUICommandList > &CommandList, const FToolBarExtensionDelegate &ToolBarExtensionDelegate)
SLATE_API void	RemoveExtension (const TSharedRef< const FExtensionBase > &Extension)
SLATE_API void	Apply (FName ExtensionHook, EExtensionHook::Position HookPosition, FMenuBarBuilder &MenuBarBuilder) const
SLATE_API void	Apply (FName ExtensionHook, EExtensionHook::Position HookPosition, FMenuBuilder &MenuBuilder) const
SLATE_API void	Apply (FName ExtensionHook, EExtensionHook::Position HookPosition, FToolBarBuilder &ToolBarBuilder) const
int32	NumExtensions () const

Static Public Member Functions
static SLATE_API TSharedRef< FExtender >	Combine (const TArray< TSharedPtr< FExtender > > &Extenders)

Member Function Documentation

AddMenuBarExtension()

TSharedRef< const FExtensionBase > FExtender::AddMenuBarExtension	(	FName	ExtensionHook,
		EExtensionHook::Position	HookPosition,
		const TSharedPtr< FUICommandList > &	CommandList,
		const FMenuBarExtensionDelegate &	MenuBarExtensionDelegate
	)

Extends a menu bar at the specified extension point

Parameters

ExtensionHook	Part of the menu to extend. You can extend the same point multiple times, and extensions will be applied in the order they were registered.
HookPosition	Where to apply hooks in relation to the extension hook
CommandList	The UI command list responsible for handling actions for the menu items you'll be extending the menu with
MenuExtensionDelegate	Called to populate the part of the menu you're extending

Returns

Pointer to the new extension object. You can use this later to remove the extension.

AddMenuExtension()

TSharedRef< const FExtensionBase > FExtender::AddMenuExtension	(	FName	ExtensionHook,
		EExtensionHook::Position	HookPosition,
		const TSharedPtr< FUICommandList > &	CommandList,
		const FMenuExtensionDelegate &	MenuExtensionDelegate
	)

Extends a menu at the specified extension point

Parameters

ExtensionHook	Part of the menu to extend. You can extend the same point multiple times, and extensions will be applied in the order they were registered.
HookPosition	Where to apply hooks in relation to the extension hook
CommandList	The UI command list responsible for handling actions for the menu items you'll be extending the menu with
MenuExtensionDelegate	Called to populate the part of the menu you're extending

Returns

Pointer to the new extension object. You can use this later to remove the extension.

AddToolBarExtension()

TSharedRef< const FExtensionBase > FExtender::AddToolBarExtension	(	FName	ExtensionHook,
		EExtensionHook::Position	HookPosition,
		const TSharedPtr< FUICommandList > &	CommandList,
		const FToolBarExtensionDelegate &	ToolBarExtensionDelegate
	)

Extends a tool bar at the specified extension point

Parameters

ExtensionHook	Part of the menu to extend. You can extend the same point multiple times, and extensions will be applied in the order they were registered.
HookPosition	Where to apply hooks in relation to the extension hook
CommandList	The UI command list responsible for handling actions for the toolbar items you'll be extending the menu with
ToolbarExtensionDelegate	Called to populate the part of the toolbar you're extending

Returns

Pointer to the new extension object. You can use this later to remove the extension.

Apply() [1/3]

void FExtender::Apply	(	FName	ExtensionHook,
		EExtensionHook::Position	HookPosition,
		FMenuBarBuilder &	MenuBarBuilder
	)		const

Applies any menu bar extensions at the specified extension point

Parameters

ExtensionHook	The point we're apply extensions to right now. Only extensions that match this point will be applied.
HookPosition	Where in relation to the hook will extensions be applied to
MenuBarBuilder	The menu bar that will be modified with the extensions in-place

Apply() [2/3]

void FExtender::Apply	(	FName	ExtensionHook,
		EExtensionHook::Position	HookPosition,
		FMenuBuilder &	MenuBuilder
	)		const

Applies any extensions at the specified extension point

Parameters

ExtensionHook	The point we're apply extensions to right now. Only extensions that match this point will be applied.
HookPosition	Where in relation to the hook will extensions be applied to
MenuBuilder	The menu that will be modified with the extensions in-place

Apply() [3/3]

void FExtender::Apply	(	FName	ExtensionHook,
		EExtensionHook::Position	HookPosition,
		FToolBarBuilder &	ToolBarBuilder
	)		const

Applies any extensions at the specified extension point

Parameters

ExtensionHook	The point we're apply extensions to right now. Only extensions that match this point will be applied.
HookPosition	Where in relation to the hook will extensions be applied to
ToolBarBuilder	The toolbar that will be modified with the extensions in-place

Combine()

TSharedRef< FExtender > FExtender::Combine ( const TArray< TSharedPtr< FExtender > > &  Extenders )

static

Consolidates an array of FExtenders into a single FExtender

Parameters

Extenders

The array of FExtenders to consolidate

Returns

A new FExtender pointer that has all of the extensions of the input

NumExtensions()

int32 FExtender::NumExtensions ( ) const

inline

Returns the number of extensions in the extender

RemoveExtension()

void FExtender::RemoveExtension

(

const TSharedRef< const FExtensionBase > &

Extension

)

Removes an existing extension.

Parameters

Extension

The extension to remove

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxExtender.h
• Engine/Source/Runtime/Slate/Private/Framework/MultiBox/MultiBoxExtender.cpp