Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > GraphEditor > SCommentBubble

Light Theme

Dark Theme

SCommentBubble

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SCommentBubble

References

Module	GraphEditor
Header	/Engine/Source/Editor/GraphEditor/Public/SCommentBubble.h
Include	#include "SCommentBubble.h"

Syntax

class SCommentBubble : public SCompoundWidget

Variables

	Name	Description
bool	bAllowPinning	Allow pin behaviour
bool	bEnableBubbleCtrls	Allow in bubble controls
bool	bEnableTitleBarBubble	Enable the title bar bubble toggle
bool	bInvertLODCulling	Invert the LOD culling behavior, used by comment nodes
FString	CachedComment	Cached comment
FText	CachedCommentText	Cached FText comment
TAttribute< FSl...	ColorAndOpacity	The Comment Bubble color and opacity value
TAttribute< FSt...	CommentAttribute	Attribute to query node comment
FLinearColor	ForegroundColor	Current Foreground Color
TAttribute< EGr...	GraphLOD	Attribute to query current LOD
UEdGraphNode &#...	GraphNode	The GraphNode this widget interacts with
TAttribute< FTe...	HintText	Hint Text
FIsGraphNodeHov...	IsGraphNodeHovered	Delegate to determine if the graph node is currently hovered
FOnTextCommitte...	OnTextCommittedDelegate	Optional delegate to call when the comment text is committed
FOnCommentBubbl...	OnToggledDelegate	Optional delegate to call when the comment bubble is toggled
float	OpacityValue	Used to Control hover fade up/down for widgets
TSharedPtr< SMu...	TextBlock	Cached inline editable text box
TAttribute< ECh...	ToggleButtonCheck	Toggle button checked state

Functions

	Name	Description
void	Construct ( const FArguments& InArgs )	Construct this widget. Called by the SNew()Slate macro.
float	GetArrowCenterOffset()	Returns the offset to the arrow center accounting for zoom on either the comment bubble or the title bar button based on current state
FSlateColor	GetBubbleColor()	Returns the color of the main bubble
EVisibility	GetBubbleVisibility()	Called to determine if the comment bubble's current visibility
FVector2D	GetOffset()	Returns the offset from the SNode center slot
ECheckBoxSta...	GetPinnedButtonCheck()	Returns pinned check state
FText	GetScaleButtonTooltip()	Returns the current scale button tooltip
FVector2D	GetSize()	Returns the bubble size
FSlateColor	GetTextBackgroundColor()	Returns the current background color for the textbox
FSlateColor	GetTextForegroundColor()	Returns the current foreground color for the textbox
ECheckBoxSta...	GetToggleButtonCheck()	Returns bubble toggle check state
FSlateColor	GetToggleButtonColor()	Returns the color for the toggle bubble including the opacity value
EVisibility	GetToggleButtonVisibility()	Called to determine if the toggle button's current visibility
bool	IsBubbleVisible()	Returns if comment bubble is visible
bool	IsReadOnly()	Called to determine if the comment bubble is readonly
bool	IsScalingAllowed()	Returns if graph scaling can be applied to this bubble
void	OnCommentBubbleToggle ( ECheckBoxState State )	Called to display/hide the comment bubble
void	OnCommentTextCommitted ( const FText& NewText, ETextCommit::Type CommitInfo )	Called when the comment text is committed
void	OnPinStateToggle ( ECheckBoxState State )	Called when a node's comment bubble pinned state is changed
void	SetCommentBubbleVisibility ( bool bVisible )	Directly sets the bubble's visibility, without assuming it was from a user action (no undo transaction, or OnToggled callback)
bool	TextBlockHasKeyboardFocus()	Returns if the text block currently has keyboard focus
void	TickVisibility ( const double InCurrentTime, const float InDeltaTime )	Updates the comment Visibility
void	UpdateBubble()	Called to update the bubble widget layout

Overridden from SWidget

	Name	Description
FSlateColor	GetForegroundColor()	Returns the foreground color for the text and buttons, taking into account the bubble color
FCursorReply	OnCursorQuery ( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent )	The system asks each widget under the mouse to provide a cursor. This event is bubbled.
void	Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )	Ticks this widget with Geometry.

Classes

	Name	Description
	FArguments

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss