AzToolsFramework::AssetBrowser::SourceFileOpenerDetails Struct Reference

#include <AssetBrowserBus.h>

Public Types
typedef AZStd::function< void(const char *, const AZ::Uuid &)>	SourceFileOpenerFunctionType
	You provide a function to call (you may use std-bind to bind to your class) if your opener is chosen to handle the open operation.

Public Member Functions
	SourceFileOpenerDetails (const char *identifier, const char *displayText, QIcon icon, SourceFileOpenerFunctionType functionToCall)

Public Attributes
AZStd::string	m_identifier
	choose something unique for your opener. It may be used to restore state. it will not be shown to user.
AZStd::string	m_displayText
QIcon	m_iconToUse
	optional. Same as m_displayText. Used when there's ambiguity. If empty, no icon.
SourceFileOpenerFunctionType	m_opener

Detailed Description

This struct is used to respond about being able to open source files. See AssetBrowserInteractionNotifications::OpenSourceFileInEditor below

Member Data Documentation

m_displayText

AZStd::string AzToolsFramework::AssetBrowser::SourceFileOpenerDetails::m_displayText

m_displayText is used when more than one listener offers to open this kind of file and we need the user to pick which one they want. They will be offered all the available openers in a menu which shows this text, and the one they pick will get its SourceFileOpenerFunctionType called.

m_opener

SourceFileOpenerFunctionType AzToolsFramework::AssetBrowser::SourceFileOpenerDetails::m_opener

This is the function to call. If you fill a nullptr in here, then the default operating system behavior will be suppressed but no opener will be opened. This will also cause the 'open' option in context menus to disappear if the only openers are nullptr ones.

---

The documentation for this struct was generated from the following file:

• Code/Framework/AzToolsFramework/AzToolsFramework/AssetBrowser/AssetBrowserBus.h