c4d.gui.BaseCustomGui¶

class c4d.gui.BaseCustomGui¶: The base class for custom GUI libraries.

Children Classes:

Overview¶

Activation And Defaults
`BaseCustomGui.Activate()`	Activates the custom GUI.
`BaseCustomGui.SetDefaultForResEdit()`	Sets the custom GUI to the resource editor defaults.
Dimensions
`BaseCustomGui.GetHeight()`	Retrieves the height of the custom GUI in pixels.
`BaseCustomGui.GetWidth()`	Retrieves the width of the custom GUI in pixels.
Rendering And Layout
`BaseCustomGui.GetLayoutMode()`	Retrieves the layout mode.
`BaseCustomGui.LayoutChanged()`	Tells the custom GUI that the layout has changed.
`BaseCustomGui.Redraw()`	Redraws the custom GUI.
`BaseCustomGui.SetLayoutMode()`	Sets the layout mode.
`BaseCustomGui.SupportLayoutSwitch()`	Checks if the custom GUI supports layout switching.
State And Data
`BaseCustomGui.GetData()`	Retrieves the custom GUI data.
`BaseCustomGui.SetData()`	Sets the custom GUI data.

Members¶

Activation And Defaults¶

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.

Dimensions¶

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.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.

Rendering And Layout¶

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.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.Redraw(self)¶: Redraws the custom GUI.

New in version R18.011.

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.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.

State And Data¶

BaseCustomGui.GetData(self)¶

Retrieves the custom GUI data.

New in version R18.011.

Return type: Any
Returns: The current data.

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.

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.