GH_ExtendableMenu Class

A menu on a custom component that can be extended and collapsed.

Inheritance Hierarchy

SystemObject
Karamba.GHopper.Utilities.UIWidgetsGH_Attr_Widget
Karamba.GHopper.Utilities.UIWidgetsGH_ExtendableMenu

Namespace: Karamba.GHopper.Utilities.UIWidgets
Assembly: Karamba3D (in Karamba3D.dll) Version: 2.2.0.5 (2.2.0.5)

Syntax

C++

Copy

public class GH_ExtendableMenu : GH_Attr_Widget

Public Class GH_ExtendableMenu
	Inherits GH_Attr_Widget

public ref class GH_ExtendableMenu : public GH_Attr_Widget

type GH_ExtendableMenu =  
    class
        inherit GH_Attr_Widget
    end

The GH_ExtendableMenu type exposes the following members.

Constructors

	Name	Description
	GH_ExtendableMenu	Initializes a new instance of the GH_ExtendableMenu class. Create a new extendable menu.

Top

Properties

	Name	Description
	Bounds	Widget's local space bounds. (Inherited from GH_Attr_Widget.)
	CanvasBounds	Widget's canvas space bounds. (Inherited from GH_Attr_Widget.)
	CanvasPivot	Get widget pivot in canvas space. (Inherited from GH_Attr_Widget.)
	Collection
	Controlls	Get controlls.
	Desciption	Get or set widget's description. (Inherited from GH_Attr_Widget.)
	Enabled	Get or set widget's state. (Inherited from GH_Attr_Widget.)
	Expanded
	Header	Get or set widget's header. (Inherited from GH_Attr_Widget.)
	Height	Get or set widget's height. (Inherited from GH_Attr_Widget.)
	Index	Get widget's index. (Inherited from GH_Attr_Widget.)
	Inputs
	Name	(Overrides GH_Attr_WidgetName.)
	Outputs
	Palette	Get or set widget's render palette. (Inherited from GH_Attr_Widget.)
	Parent	Get or set widget's parent. (Inherited from GH_Attr_Widget.)
	ShowToolTip	Set tool tip visibility. (Inherited from GH_Attr_Widget.)
	Style	Get or set widget's render palette. (Inherited from GH_Attr_Widget.)
	TopCollection	Get menu collection, the widget belongs to. (Inherited from GH_Attr_Widget.)
	TotalHeight	Get total height of extendable menu.
	Transform	Widget's transformation. Is set by the parent of the widget. The widget itself should only read from this field. (Inherited from GH_Attr_Widget.)
	Width	Get or set widget's width. (Inherited from GH_Attr_Widget.)

Top

Methods

	Name	Description
	AddControl	Add control to menu.
	Collapse	Colapse menu.
	ComputeMinSize	(Overrides GH_Attr_WidgetComputeMinSize.)
	Contains	Check if widget bounds contains given point. By default the CanvasBounds of the widget will be consulted. (Inherited from GH_Attr_Widget.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Expand	Expand menu.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWidgetDescription	(Overrides GH_Attr_WidgetGetWidgetDescription.)
	IsTtipPoint	(Overrides GH_Attr_WidgetIsTtipPoint(PointF).)
	Layout	Layout menu. (Overrides GH_Attr_WidgetLayout.)
	MakeAllInActive
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnRender	Render widget to canvas. (Inherited from GH_Attr_Widget.)
	PostUpdateBounds	Is invoked after the bounds of the widget has been updated. (Inherited from GH_Attr_Widget.)
	Read	(Overrides GH_Attr_WidgetRead(GH_IReader).)
	RegisterInputPlug(ExtendedPlug)	Register input plug.
	RegisterInputPlug(ListExtendedPlug)
	RegisterOutputPlug(ExtendedPlug)	Register output plug.
	RegisterOutputPlug(ListExtendedPlug)	Register output plug.
	Render	(Overrides GH_Attr_WidgetRender(WidgetRenderArgs).)
	RenderMenuParameters
	RespondToKeyDown	(Inherited from GH_Attr_Widget.)
	RespondToMouseDoubleClick	(Overrides GH_Attr_WidgetRespondToMouseDoubleClick(GH_Canvas, GH_CanvasMouseEvent).)
	RespondToMouseDown	(Overrides GH_Attr_WidgetRespondToMouseDown(GH_Canvas, GH_CanvasMouseEvent).)
	RespondToMouseMove	(Overrides GH_Attr_WidgetRespondToMouseMove(GH_Canvas, GH_CanvasMouseEvent).)
	RespondToMouseUp	(Overrides GH_Attr_WidgetRespondToMouseUp(GH_Canvas, GH_CanvasMouseEvent).)
	TooltipSetup	(Overrides GH_Attr_WidgetTooltipSetup(PointF, GH_TooltipDisplayEventArgs).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateBounds	Update widget bounds. (Inherited from GH_Attr_Widget.)
	Write	(Overrides GH_Attr_WidgetWrite(GH_IWriter).)

Top

Fields

	Name	Description
	_description	Widget description. (Inherited from GH_Attr_Widget.)
	_enabled	True if the widget is enabled. (Inherited from GH_Attr_Widget.)
	_header	Widget description header. (Inherited from GH_Attr_Widget.)
	_index	Local widget index. Used to identify the widget within its local group. ??? what is the index actually used for?. (Inherited from GH_Attr_Widget.)
	_name	Widget name. (Inherited from GH_Attr_Widget.)
	_showToolTip	True if the widget has a tool tip and it should be shown when requested. (Inherited from GH_Attr_Widget.)
	bounds	Widget's local space bounds. (Inherited from GH_Attr_Widget.)
	canvasBounds	Widget's canvas space bounds. (Inherited from GH_Attr_Widget.)
	palette	The palette. (Inherited from GH_Attr_Widget.)
	parent	The parent widget. If null, this widget is not nested. (Inherited from GH_Attr_Widget.)
	style	Widget palette style. (Inherited from GH_Attr_Widget.)
	transfromation	Widget transformation. (Inherited from GH_Attr_Widget.)

Top

Reference

Karamba.GHopper.Utilities.UIWidgets Namespace