GH_Attr_Widget Class

Grasshopper attribute widgets.

Inheritance Hierarchy

SystemObject
Karamba.GHopper.Utilities.UIWidgetsGH_Attr_Widget
More...

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

Syntax

public abstract class GH_Attr_Widget

Public MustInherit Class GH_Attr_Widget

public ref class GH_Attr_Widget abstract

[<AbstractClassAttribute>]
type GH_Attr_Widget =  class end

The GH_Attr_Widget type exposes the following members.

Constructors

	Name	Description
	GH_Attr_Widget	Initializes a new instance of the GH_Attr_Widget class

Properties

	Name	Description
	Bounds	Widget's local space bounds.
	CanvasBounds	Widget's canvas space bounds.
	CanvasPivot	Get widget pivot in canvas space.
	Desciption	Get or set widget's description.
	Enabled	Get or set widget's state.
	Header	Get or set widget's header.
	Height	Get or set widget's height.
	Index	Get widget's index.
	Name	Get or set widget's name.
	Palette	Get or set widget's render palette.
	Parent	Get or set widget's parent.
	ShowToolTip	Set tool tip visibility.
	Style	Get or set widget's render palette.
	TopCollection	Get menu collection, the widget belongs to.
	Transform	Widget's transformation. Is set by the parent of the widget. The widget itself should only read from this field.
	Width	Get or set widget's width.

Methods

	Name	Description
	ComputeMinSize	Computes widget's minimum size.
	Contains	Check if widget bounds contains given point. By default the CanvasBounds of the widget will be consulted.
	Convert	Convert float rectange to integer rectangle.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	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
	IsTtipPoint	Get widget at point. If no widget is in range of given point, null is returned.
	Layout	Layout widget.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnRender	Render widget to canvas.
	PostUpdateBounds	Is invoked after the bounds of the widget has been updated.
	Read	Deserialize widget.
	Render	Render widget onto canvas. Override this method to defined the widget's render procedure.
	RespondToKeyDown
	RespondToMouseDoubleClick
	RespondToMouseDown
	RespondToMouseMove
	RespondToMouseUp
	Shrink	Shrink rectangle.
	TooltipSetup	Setup widget's tool tip.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateBounds	Update widget bounds.
	Write	Serialize widget.

Fields

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

Inheritance Hierarchy