c4d.gui.BaseCustomGui ¶

The base class for custom GUI libraries.

Definition ¶

class c4d.gui. BaseCustomGui ¶

• BaseCustomGui.GetWidth()
• BaseCustomGui.GetHeight()
• BaseCustomGui.Redraw()
• BaseCustomGui.LayoutChanged()
• BaseCustomGui.Activate()
• BaseCustomGui.SetDefaultForResEdit()
• BaseCustomGui.SetData()
• BaseCustomGui.GetData()
• BaseCustomGui.SetLayoutMode()
• BaseCustomGui.GetLayoutMode()
• BaseCustomGui.SupportLayoutSwitch()

Inheritance ¶

• c4d.gui.BaseCustomGui

  • c4d.gui.SplineCustomGui
  • c4d.gui.DateTimeControl
  • c4d.gui.GradientCustomGui
  • c4d.gui.LinkBoxGui
  • c4d.gui.HtmlViewerCustomGui
  • c4d.gui.QuickTabCustomGui
  • c4d.gui.TreeViewCustomGui
  • c4d.gui.BitmapButtonCustomGui
  • c4d.gui.InExcludeCustomGui
  • c4d.gui.DescriptionCustomGui
  • c4d.gui.HyperLinkCustomGui
  • c4d.gui.FontChooserCustomGui
  • c4d.gui.RangeCustomGui

Members ¶

BaseCustomGui. GetWidth ( ) ¶

New in version R18.011.

Retrieves the width of the custom GUI in pixels.

Return type:	int
Returns:	The width of the custom GUI.

BaseCustomGui. GetHeight ( ) ¶

New in version R18.011.

Retrieves the height of the custom GUI in pixels.

Return type:	int
Returns:	The height of the custom GUI.

BaseCustomGui. Redraw ( ) ¶

New in version R18.011.

Redraws the custom GUI.

BaseCustomGui. LayoutChanged ( ) ¶

New in version R18.011.

Tells the custom GUI that the layout has changed.

Return type:	bool
Returns:	True if successful, otherwise False .

BaseCustomGui. Activate ( ) ¶

New in version R18.011.

Private.

BaseCustomGui. SetDefaultForResEdit ( ) ¶

New in version R18.011.

Sets the custom GUI to the resource editor defaults.

Return type:	bool
Returns:	True if successful, otherwise False .

BaseCustomGui. SetData ( data ) ¶

New in version R18.011.

Sets the custom GUI data.

Parameters:	data ( any ) – The new data.
Return type:	bool
Returns:	True if successful, otherwise False .

BaseCustomGui. GetData ( ) ¶

New in version R18.011.

Retrieves the custom GUI data.

Return type:	any
Returns:	The current data.

BaseCustomGui. SetLayoutMode ( mode ) ¶

New in version R18.011.

Sets the layout mode.

Parameters:	mode ( int ) – The new layout mode: LAYOUTMODE_NONE Does not support layout modes. LAYOUTMODE_MINIMIZED Minimized. LAYOUTMODE_MAXIMIZED Maximized.

BaseCustomGui. GetLayoutMode ( ) ¶

New in version R18.011.

Retrieves the layout mode.

Return type:	int
Returns:	The current layout mode: LAYOUTMODE_NONE Does not support layout modes. LAYOUTMODE_MINIMIZED Minimized. LAYOUTMODE_MAXIMIZED Maximized.

BaseCustomGui. SupportLayoutSwitch ( ) ¶

New in version R18.011.

Checks if the custom GUI supports layout switching.

Return type:	bool
Returns:	True if the layout switch is supported, otherwise False .

Table Of Contents

• c4d.gui.BaseCustomGui
  • Definition
  • Inheritance
  • Members