Class RenamePopup
Popup menu useful for renaming objects via UI. Displays text box for renaming.
Implements
System.IComparable
Namespace: FlaxEditor.GUI
Assembly: FlaxEngine.CSharp.dll
Syntax
public class RenamePopup : ContextMenuBase, IComparable, IDrawable
Constructors
RenamePopup(String, Float2, Boolean)
Initializes a new instance of the RenamePopup class.
Declaration
public RenamePopup(string value, Float2 size, bool isMultiline)
Parameters
System.String
value
The value. |
Float2
size
The size. |
System.Boolean
isMultiline
Enable/disable multiline text input support |
Fields
Validate
Occurs when input text validation should be performed.
Declaration
public RenamePopup.ValidateDelegate Validate
Field Value
RenamePopup.ValidateDelegate
|
Properties
InitialValue
Gets or sets the initial value.
Declaration
public string InitialValue { get; set; }
Property Value
System.String
|
InputField
Gets the text input field control.
Declaration
public TextBox InputField { get; }
Property Value
TextBox
|
Text
Gets or sets the input field text.
Declaration
public string Text { get; set; }
Property Value
System.String
|
UseAutomaticDirectionFix
Declaration
protected override bool UseAutomaticDirectionFix { get; }
Property Value
System.Boolean
|
Overrides
FlaxEditor.GUI.ContextMenu.ContextMenuBase.UseAutomaticDirectionFix
Methods
OnDestroy()
Declaration
public override void OnDestroy()
Overrides
FlaxEditor.GUI.ContextMenu.ContextMenuBase.OnDestroy()
OnHide()
Declaration
protected override void OnHide()
Overrides
FlaxEditor.GUI.ContextMenu.ContextMenuBase.OnHide()
OnKeyDown(KeyboardKeys)
Declaration
public override bool OnKeyDown(KeyboardKeys key)
Parameters
KeyboardKeys
key
|
Returns
System.Boolean
|
Overrides
FlaxEditor.GUI.ContextMenu.ContextMenuBase.OnKeyDown(FlaxEngine.KeyboardKeys)
OnShow()
Declaration
protected override void OnShow()
Overrides
FlaxEditor.GUI.ContextMenu.ContextMenuBase.OnShow()
Show(Control, Rectangle, String, Boolean)
Shows the rename popup.
Declaration
public static RenamePopup Show(Control control, Rectangle area, string value, bool isMultiline)
Parameters
Control
control
The target control. |
Rectangle
area
The target control area to cover. |
System.String
value
The initial value. |
System.Boolean
isMultiline
Enable/disable multiline text input support |
Returns
RenamePopup
Created popup. |
Update(Single)
Declaration
public override void Update(float deltaTime)
Parameters
System.Single
deltaTime
|
Overrides
FlaxEditor.GUI.ContextMenu.ContextMenuBase.Update(System.Single)
Events
Closed
Occurs when popup is closing (after renaming done or not).
Declaration
public event Action<RenamePopup> Closed
Event Type
System.Action<RenamePopup>
|
Renamed
Occurs when renaming is done.
Declaration
public event Action<RenamePopup> Renamed
Event Type
System.Action<RenamePopup>
|
Extension Methods
See Also
FlaxEditor.GUI.ContextMenu.ContextMenuBase