ooodev.adapter.awt.uno_control_image_control_model_partial module

class ooodev.adapter.awt.uno_control_image_control_model_partial.UnoControlImageControlModelPartial(component)[source]

Bases: UnoControlModelPartial

Partial class for UnoControlImageControlModel.

Parameters:: component (UnoControlImageControlModel) –

__init__(component)[source]

Constructor

Parameters:: component (Any) – Component that implements com.sun.star.awt.UnoControlImageControlModel service.

property background_color: Color

Gets/Set the background color of the control.

Returns:: Color
Return type:: Color

property border: BorderKind

Gets/Sets the border style of the control.

Note

Value can be set with BorderKind or int.

Hint

BorderKind can be imported from ooodev.utils.kind.border_kind.

Return type:: BorderKind

property border_color: Color | None

Gets/Sets the color of the border, if present

Not every border style (see Border) may support coloring. For instance, usually a border with 3D effect will ignore the border_color setting.

optional

Returns:: Color or None if not set.
Return type:: Color | None

property enabled: bool

Gets/Sets whether the control is enabled or disabled.

Return type:: bool

property graphic: XGraphic | None

specifies a graphic to be displayed at the button

If this property is present, it interacts with the image_url in the following way:

If image_url is set, graphic will be reset to an object as loaded from the given image URL, or None if image_url does not point to a valid image file.
If graphic is set, image_url will be reset to an empty string.

optional

Return type:: XGraphic | None

property help_text: str

Get/Sets the help text of the control.

Return type:: str

property help_url: str

Gets/Sets the help URL of the control.

Return type:: str

property image_url: str

Gets/Sets a URL to an image to use for the button.

Return type:: str

property printable: bool

Gets/Sets that the control will be printed with the document.

Return type:: bool

property scale_image: bool

Gets/Sets if the image is automatically scaled to the size of the control.

Return type:: bool

property scale_mode: ImageScaleModeEnum | None

defines how to scale the image

If this property is present, it supersedes the ScaleImage property.

The value of this property is one of the ImageScaleMode constants.

optional

Note

Value can be set with ImageScaleModeEnum or int.

Hint

ImageScaleModeEnum can be imported from ooo.dyn.awt.image_scale_mode

Return type:: ImageScaleModeEnum | None

property tabstop: bool | None

Gets/Sets that the control can be reached with the TAB key.

optional

Return type:: bool | None