c4d.gui.BaseCustomGui

class c4d.gui.BaseCustomGui

The base class for custom GUI libraries.

Children Classes:

• c4d.gui.LinkBoxGui

• c4d.gui.InExcludeCustomGui

• c4d.gui.HtmlViewerCustomGui

• c4d.gui.SplineCustomGui

• c4d.gui.SoundEffectorCustomGui

• c4d.gui.TreeViewCustomGui

• c4d.gui.GradientCustomGui

• c4d.gui.DescriptionCustomGui

• c4d.gui.BitmapButtonCustomGui

• c4d.gui.QuickTabCustomGui

• c4d.gui.DateTimeControl

• c4d.gui.HyperLinkCustomGui

• c4d.gui.FontChooserCustomGui

• c4d.gui.RangeCustomGui

Overview

BaseCustomGui.GetWidth	Retrieves the width of the custom GUI in pixels.
BaseCustomGui.GetHeight	Retrieves the height of the custom GUI in pixels.
BaseCustomGui.Redraw	Redraws the custom GUI.
BaseCustomGui.LayoutChanged	Tells the custom GUI that the layout has changed.
BaseCustomGui.Activate	Activates the custom GUI.
BaseCustomGui.SetDefaultForResEdit	Sets the custom GUI to the resource editor defaults.
BaseCustomGui.SetData	Sets the custom GUI data.
BaseCustomGui.GetData	Retrieves the custom GUI data.
BaseCustomGui.SetLayoutMode	Sets the layout mode.
BaseCustomGui.GetLayoutMode	Retrieves the layout mode.
BaseCustomGui.SupportLayoutSwitch	Checks if the custom GUI supports layout switching.

Members

BaseCustomGui.GetWidth(self)

Retrieves the width of the custom GUI in pixels.

New in version R18.011.

Return type

int

Returns

The width of the custom GUI.

BaseCustomGui.GetHeight(self)

Retrieves the height of the custom GUI in pixels.

New in version R18.011.

Return type

int

Returns

The height of the custom GUI.

BaseCustomGui.Redraw(self)

Redraws the custom GUI.

New in version R18.011.

BaseCustomGui.LayoutChanged(self)

Tells the custom GUI that the layout has changed.

New in version R18.011.

Return type

bool

Returns

True if successful, otherwise False.

BaseCustomGui.Activate(self)

Activates the custom GUI.

New in version R18.011.

Return type

bool

Returns

True if successful, otherwise False.

BaseCustomGui.SetDefaultForResEdit(self)

Sets the custom GUI to the resource editor defaults.

New in version R18.011.

Return type

bool

Returns

True if successful, otherwise False.

BaseCustomGui.SetData(self, data)

Sets the custom GUI data.

New in version R18.011.

Parameters

data (any) – The new data.

Return type

bool

Returns

True if successful, otherwise False.

BaseCustomGui.GetData(self)

Retrieves the custom GUI data.

New in version R18.011.

Return type

Any

Returns

The current data.

BaseCustomGui.SetLayoutMode(self, mode)

Sets the layout mode.

New in version R18.011.

Parameters

mode (int) –

The new layout mode:

LAYOUTMODE_NONE	Does not support layout modes.
LAYOUTMODE_MINIMIZED	Minimized.
LAYOUTMODE_MAXIMIZED	Maximized.

BaseCustomGui.GetLayoutMode(self)

Retrieves the layout mode.

New in version R18.011.

Return type

int

Returns

The current layout mode:

LAYOUTMODE_NONE	Does not support layout modes.
LAYOUTMODE_MINIMIZED	Minimized.
LAYOUTMODE_MAXIMIZED	Maximized.

BaseCustomGui.SupportLayoutSwitch(self)

Checks if the custom GUI supports layout switching.

New in version R18.011.

Return type

bool

Returns

True if the layout switch is supported, otherwise False.