using System;
using System.Runtime.CompilerServices;
using BansheeEngine;
namespace BansheeEditor
{
///
/// Editor GUI element that displays a list box with user-specified elements and an optional label.
///
public sealed class GUIListBoxField : GUIElement
{
public delegate void OnSelectionChangedDelegate(int index);
///
/// Triggered whenever user selects a new element in the list box. Returned index maps to the element in the
/// elements array that the list box was initialized with.
///
public event OnSelectionChangedDelegate OnSelectionChanged;
///
/// Index of the list box entry currently selected.
///
public int Index
{
get { return Internal_GetValue(mCachedPtr); }
set { Internal_SetValue(mCachedPtr, value); }
}
///
/// Creates a new list box with the specified elements and a label.
///
/// Array of elements to display in the list box. Elements will be displayed in the same
/// order as in the array.
/// Content to display on the label.
/// Width of the title label in pixels.
/// Optional style to use for the element. Style controls the look of the element, as well as
/// default layout options. Style will be retrieved from the active GUISkin. If not specified
/// default element style is used.
/// Options that allow you to control how is the element positioned and sized. This will
/// override any similar options set by style.
public GUIListBoxField(LocString[] elements, GUIContent title, int titleWidth = 100, string style = "",
params GUIOption[] options)
{
Internal_CreateInstance(this, elements, title, titleWidth, style, options, true);
}
///
/// Creates a new list box with the specified elements and a label.
///
/// Array of elements to display in the list box. Elements will be displayed in the same
/// order as in the array.
/// Content to display on the label.
/// Width of the title label in pixels.
/// Options that allow you to control how is the element positioned and sized. This will
/// override any similar options set by style.
public GUIListBoxField(LocString[] elements, GUIContent title, int titleWidth = 100, params GUIOption[] options)
{
Internal_CreateInstance(this, elements, title, titleWidth, "", options, true);
}
///
/// Creates a new list box with the specified elements and no label.
///
/// Array of elements to display in the list box. Elements will be displayed in the same
/// order as in the array.
/// Optional style to use for the element. Style controls the look of the element, as well as
/// default layout options. Style will be retrieved from the active GUISkin. If not specified
/// default element style is used.
/// Options that allow you to control how is the element positioned and sized. This will
/// override any similar options set by style.
public GUIListBoxField(LocString[] elements, string style = "", params GUIOption[] options)
{
Internal_CreateInstance(this, elements, null, 0, style, options, false);
}
///
/// Creates a new list box with the specified elements and no label.
///
/// Array of elements to display in the list box. Elements will be displayed in the same
/// order as in the array.
/// Options that allow you to control how is the element positioned and sized. This will
/// override any similar options set by style.
public GUIListBoxField(LocString[] elements, params GUIOption[] options)
{
Internal_CreateInstance(this, elements, null, 0, "", options, false);
}
///
/// Updates the list box with a new set of elements.
///
/// Array of elements to display in the list box. Elements will be displayed in the same
/// order as in the array.
public void SetElements(LocString[] elements)
{
Internal_SetElements(mCachedPtr, elements);
}
///
/// Colors the element with a specific tint.
///
/// Tint to apply to the element.
public void SetTint(Color color)
{
Internal_SetTint(mCachedPtr, color);
}
///
/// Triggered by the native interop object when a user selects an object in the list.
///
private void DoOnSelectionChanged(int index)
{
if (OnSelectionChanged != null)
OnSelectionChanged(index);
}
[MethodImpl(MethodImplOptions.InternalCall)]
private static extern void Internal_CreateInstance(GUIListBoxField instance, LocString[] entries,
GUIContent title, int titleWidth, string style, GUIOption[] options, bool withTitle);
[MethodImpl(MethodImplOptions.InternalCall)]
private static extern void Internal_SetElements(IntPtr nativeInstance, LocString[] elements);
[MethodImpl(MethodImplOptions.InternalCall)]
private static extern int Internal_GetValue(IntPtr nativeInstance);
[MethodImpl(MethodImplOptions.InternalCall)]
private static extern void Internal_SetValue(IntPtr nativeInstance, int value);
[MethodImpl(MethodImplOptions.InternalCall)]
private static extern void Internal_SetTint(IntPtr nativeInstance, Color color);
}
}