Open 3D Engine GraphCanvas Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
GraphCanvas::CommentNodeTextComponent Class Reference

Inherits GraphCanvas::GraphCanvasPropertyComponent, NodeNotificationBus::Handler, CommentRequestBus::Handler, CommentLayoutRequestBus::Handler, EntitySaveDataRequestBus::Handler, and GraphCanvas::CommentNodeTextSaveDataInterface.

Public Member Functions

 AZ_COMPONENT (CommentNodeTextComponent, "{15C568B0-425C-4655-814D-0A299341F757}", GraphCanvasPropertyComponent)
 
 CommentNodeTextComponent (AZStd::string_view initialText)
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
void OnAddedToScene (const AZ::EntityId &) override
 
void SetComment (const AZStd::string &comment) override
 
const AZStd::string & GetComment () const override
 
void SetCommentMode (CommentMode commentMode) override
 
void SetBackgroundColor (const AZ::Color &color) override
 
AZ::Color GetBackgroundColor () const override
 
CommentMode GetCommentMode () const override
 
QGraphicsLayoutItem * GetGraphicsLayoutItem () override
 
void WriteSaveData (EntitySaveDataContainer &saveDataContainer) const override
 
void ReadSaveData (const EntitySaveDataContainer &saveDataContainer) override
 
void ApplyPresetData (const EntitySaveDataContainer &saveDataContainer) override
 
- Public Member Functions inherited from GraphCanvas::GraphCanvasPropertyComponent
 AZ_COMPONENT (GraphCanvasPropertyComponent, "{12408A55-4742-45B2-8694-EE1C80430FB4}")
 
void Init () override
 
void Activate () override
 
void Deactivate () override
 
AZ::Component * GetPropertyComponent () override
 
- Public Member Functions inherited from GraphCanvas::GraphCanvasPropertyBusHandler
void OnActivate (const AZ::EntityId &entityId)
 
void OnDeactivate ()
 
void AddBusId (const AZ::EntityId &busId) final
 
void RemoveBusId (const AZ::EntityId &busId) final
 
virtual void OnCommentChanged ()=0
 
virtual void OnBackgroundColorChanged ()=0
 
virtual void UpdateStyleOverrides ()=0
 
virtual CommentMode GetCommentMode () const =0
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *)
 
static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incombatible)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
- Static Public Member Functions inherited from GraphCanvas::GraphCanvasPropertyComponent
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void OnCommentChanged () override
 
void OnBackgroundColorChanged () override
 
void UpdateStyleOverrides () override
 

Member Function Documentation

◆ GetCommentMode()

CommentMode GraphCanvas::CommentNodeTextComponent::GetCommentMode ( ) const
overridevirtual

◆ OnBackgroundColorChanged()

void GraphCanvas::CommentNodeTextComponent::OnBackgroundColorChanged ( )
overrideprotectedvirtual

◆ OnCommentChanged()

void GraphCanvas::CommentNodeTextComponent::OnCommentChanged ( )
overrideprotectedvirtual

◆ UpdateStyleOverrides()

void GraphCanvas::CommentNodeTextComponent::UpdateStyleOverrides ( )
overrideprotectedvirtual

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