c4d.gui.BitmapButtonCustomGui ¶

Bitmap button custom GUI ( CUSTOMGUI_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
COLOR_XOR
COLOR_TRANS
COLOR_BG
COLOR_BGEDIT
COLOR_BGFOCUS
COLOR_TEXT
COLOR_TEXTFOCUS
COLOR_EDGELT
COLOR_EDGEWH
COLOR_EDGEDK
COLOR_EDGEBL
COLOR_DBARFG1
COLOR_DBARBG1
COLOR_DBARFG2
COLOR_DBARBG2
COLOR_BGGADGET
COLOR_BGSELECTEDTEXT
COLOR_FGSELECTEDTEXT
COLOR_TIMELINE
COLOR_BGTRISTATE
COLOR_BG_DARK1
COLOR_BG_DARK2
COLOR_CTIMELINE_GRIDMEDIUM	New in version R17.032.
COLOR_SB_CARET	New in version R17.032.
COLOR_SB_CARETBG	New in version R17.032.
COLOR_TEXT_AUTOTAKE	New in version R17.032.
COLOR_TEXT_AUTOTAKE_DARK	New in version R17.032.

Note

To format the bitmap’s button tooltip text ( BITMAPBUTTON_TOOLTIP ) use the <b> and <br> HTML tags. For instance this is used internally to format the tooltip text for the palettes buttons.

For example:

bc.SetString(c4d.BITMAPBUTTON_TOOLTIP, "<b>Bold Text</b><br>New line")
					

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.

Table Of Contents

• c4d.gui.BitmapButtonCustomGui
  • Definition
  • Inheritance
  • Members