SCommentBubble

Unreal Engine C++ API Reference > Editor > GraphEditor

Inheritance Hierarchy

References

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

Syntax

class SCommentBubble : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)  

Variables

Type 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
float BubbleLuminance The luminance (R + G + B) of the bubble's color, used to control text foreground color
FString CachedComment Cached comment
FText CachedCommentText Cached FText comment
FSlateColor CalculatedForegroundColor Current Foreground Color
TAttribute< FSl... ColorAndOpacity The Comment Bubble color and opacity value
TAttribute< FSt... CommentAttribute Attribute to query node comment
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

Type 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
FSlateColor GetReadOnlyTextForegroundColor ()  
FText GetScaleButtonTooltip () Returns the current scale button tooltip
FVector2D GetSize () Returns the bubble size
FSlateColor GetTextBackgroundColor ()  
FSlateColor GetTextForegroundColor ()  
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

Type 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

Type Name Description
Public struct FArguments  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library