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.
Public Types | Public Member Functions | Static Public Attributes | List of all members
GraphCanvas::CommentRequests Class Referenceabstract

#include <CommentBus.h>

Inherits AZ::EBusTraits.

Public Types

using BusIdType = AZ::EntityId
 

Public Member Functions

virtual void SetComment (const AZStd::string &)=0
 Set the name of the comment. This often acts as a kind of visual title for the comment.
 
virtual const AZStd::string & GetComment () const =0
 Get the name of the comment.
 
virtual void SetCommentMode (CommentMode commentMode)=0
 Sets the type of comment that is being used(controls how the comment resizes, how excess text is handled).
 
virtual void SetBackgroundColor (const AZ::Color &color)=0
 Sets the background color for the comment.
 
virtual AZ::Color GetBackgroundColor () const =0
 Returns the background color set for the comment.
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById
 

Detailed Description

CommentRequests Requests that get or set the properties of a comment.

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