c4d.gui.BitmapButtonCustomGui

Bitmap button custom GUI (CUSTOMDATATYPE_BITMAPBUTTON). The settings are:

BITMAPBUTTON_BORDER

int

Border mode:

Note

Used for the pressed button state if BITMAPBUTTON_OUTBORDER is set.

BORDER_NONE	No border.
BORDER_THIN_IN	Thin border inward.
BORDER_THIN_OUT	Thin border outward.
BORDER_IN	Normal border inward.
BORDER_OUT	Normal border outward.
BORDER_GROUP_IN	Group border inside.
BORDER_GROUP_OUT	Group border outside.
BORDER_OUT2	Outward border 2.
BORDER_OUT3	Outward border 3
BORDER_BLACK	Thin black line.
BORDER_ACTIVE_1	Active border 1.
BORDER_ACTIVE_2	Active border 2.
BORDER_ACTIVE_3	Active border 3.
BORDER_ACTIVE_4	Active border 4.
BORDER_GROUP_TOP	Border along the top.
BORDER_ROUND	Border with round corners.
BORDER_SCHEME_EDIT	Edit field border like the shortcut gadget for example.
BORDER_SCHEME_EDIT_NUMERIC	Edit field border that is open to the right like the link field for example.
BORDER_OUT3l	Outward border 3, open to the left.
BORDER_OUT3r	Outward border 3, open to the right.
BORDER_MASK	Masks out border type.
BORDER_WITH_TITLE_BOLD	Display group title with bold font.
BORDER_WITH_TITLE	Display group title in the border.

BITMAPBUTTON_BUTTON	bool	Clickable button. To detect when the button is pressed in a description check if the DESCFLAGS_SET_USERINTERACTION flag is set in the NodeData.SetDParameter() call.
BITMAPBUTTON_TOGGLE	bool	Toggle button, like a checkbox.
BITMAPBUTTON_IGNORE_BITMAP_WIDTH	bool	Ignore bitmap width.
BITMAPBUTTON_IGNORE_BITMAP_HEIGHT	bool	Ignore bitmap height.
BITMAPBUTTON_DRAWPOPUPBUTTON	bool	Draw popup button.
BITMAPBUTTON_TOOLTIP	str	A tooltip string.
BITMAPBUTTON_ICONID1	int	Registered icon bitmap. Pass the icon ID. (On state for toggle buttons)
BITMAPBUTTON_ICONID2	int	Registered icon bitmap. Pass the icon ID. (Off state for toggle buttons)
BITMAPBUTTON_FORCE_SIZE	bool	Private.
BITMAPBUTTON_SPECIAL	bool	Private.
BITMAPBUTTON_NOBORDERDRAW	bool	True disables border drawing.
BITMAPBUTTON_OUTBORDER	int	Border mode:

BORDER_NONE	No border.
BORDER_THIN_IN	Thin border inward.
BORDER_THIN_OUT	Thin border outward.
BORDER_IN	Normal border inward.
BORDER_OUT	Normal border outward.
BORDER_GROUP_IN	Group border inside.
BORDER_GROUP_OUT	Group border outside.
BORDER_OUT2	Outward border 2.
BORDER_OUT3	Outward border 3
BORDER_BLACK	Thin black line.
BORDER_ACTIVE_1	Active border 1.
BORDER_ACTIVE_2	Active border 2.
BORDER_ACTIVE_3	Active border 3.
BORDER_ACTIVE_4	Active border 4.
BORDER_GROUP_TOP	Border along the top.
BORDER_ROUND	Border with round corners.
BORDER_SCHEME_EDIT	Edit field border like the shortcut gadget for example.
BORDER_SCHEME_EDIT_NUMERIC	Edit field border that is open to the right like the link field for example.
BORDER_OUT3l	Outward border 3, open to the left.
BORDER_OUT3r	Outward border 3, open to the right.
BORDER_MASK	Masks out border type.
BORDER_WITH_TITLE_BOLD	Display group title with bold font.
BORDER_WITH_TITLE	Display group title in the border.

BITMAPBUTTON_BACKCOLOR

int

Background color.

COLOR_3DTEXT	For 3D text.
COLOR_XOR	Deprecated XOR lines. Use LassoSelection instead.
COLOR_TRANS	Transparent background for text.
COLOR_BG	Background color.
COLOR_BGEDIT	Edit background color.
COLOR_BGFOCUS	Focus background color.
COLOR_TEXT	Text color.
COLOR_TEXTFOCUS	Focus text color.
COLOR_EDGELT	Light edge color.
COLOR_EDGEWH	Lightest edge color.
COLOR_EDGEDK	Dark edge color.
COLOR_EDGEBL	Darkest edge color.
COLOR_DBARFG1	Dialog bar foreground color 1.
COLOR_DBARBG1	Dialog bar background color 1.
COLOR_DBARFG2	Dialog bar foreground color 2.
COLOR_DBARBG2	Dialog bar background color 2.
COLOR_BGGADGET	Gadget background color.
COLOR_BGSELECTEDTEXT	Selected text in gadgets background color.
COLOR_FGSELECTEDTEXT	Selected text in gadgets foreground color.
COLOR_TIMELINE	Timeline color.
COLOR_BGTRISTATE	Tristates background color.
COLOR_BG_DARK1	Dark background color 1.
COLOR_BG_DARK2	Dark background color 2.

Definition

class c4d.gui.BitmapButtonCustomGui

• BitmapButtonCustomGui.SetImage()
• BitmapButtonCustomGui.SetToggleState()
• BitmapButtonCustomGui.SetCommandDragId()

Inheritance

• c4d.gui.BaseCustomGui

  • c4d.gui.BitmapButtonCustomGui

Members

BitmapButtonCustomGui.SetImage(obj[, copybmp=True, secondstate=False])

Sets the image.

Parameters:

• obj (str, BaseBitmap or IconData as a dictionary) – The filename, bitmap or icon to load the image from.
• copybmp (bool) – If this is True the bitmap is copied.
• secondstate – If this is True the function stores a second state for toggle and clickable buttons.

Return type:

bool

Returns:

True if successful, otherwise False.

BitmapButtonCustomGui.SetToggleState(set)

Sets the toggle state of the button.

Parameters:set (bool) – New toggle state.

BitmapButtonCustomGui.SetCommandDragId(cmdid)

Sets a command ID for the bitmap button. This enables drag and drop of the command into tool bars and menu manager. Used e.g. in the script manager.

Parameters:cmdid (int) – The ID of the command.