Class CtlDialog

Introduction

Class for working with dialog windows.

EventArgsCallbackT

All EventArgsCallbackT callbacks include control_src as a keyword argument.

A callback can be in the format of:

def on_some_event(
    src: Any, event: EventArgs, control_src: CtlDialog, *args, **kwargs
) -> None:
    pass

or

def on_some_event(src: Any, event: EventArgs, *args, **kwargs) -> None:
    # can get control from kwargs
    ctl = cast(CtlDialog, kwargs['control_src'])

Class

class ooodev.dialog.dl_control.CtlDialog(ctl)[source]

Bases: UnoControlDialogComp, CtlListenerBase, UnitConversionPartial, TopWindowEvents, WindowEvents

Class for Dialog Control

Parameters:

args (Any) –
kwargs (Any) –

Return type:

Any

__init__(ctl)[source]

Constructor

Parameters:: ctl (UnoControlDialog) – Dialog Control.
Return type:: None

add_event_focus_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_focus_gained(cb)

Adds a listener for an event.

Event is invoked when a window gains the keyboard focus.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.FocusEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_focus_lost(cb)

Adds a listener for an event.

Event is invoked when a window loses the keyboard focus.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.FocusEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_key_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_key_pressed(cb)

Adds a listener for an event.

Event is invoked when a key has been pressed.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.KeyEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_key_released(cb)

Adds a listener for an event.

Event is invoked when a key has been released.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.KeyEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_listener(listener)

Adds an event listener to the component.

Parameters:: listener (XEventListener) – The event listener to be added.
Return type:: None

add_event_mouse_dragged(cb)

Adds a listener for an event.

Event is invoked when a mouse button is pressed on a window and then dragged.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_entered(cb)

Adds a listener for an event.

Event is invoked when the mouse enters a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_exited(cb)

Adds a listener for an event.

Event is invoked when the mouse exits a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_motion_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_moved(cb)

Adds a listener for an event.

Event Is invoked when the mouse pointer has been moved on a window (with no buttons down).

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_pressed(cb)

Adds a listener for an event.

Event is invoked when a mouse button has been pressed on a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_released(cb)

Adds a listener for an event.

Event is invoked when a mouse button has been released on a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_observers(*args)

Adds observers that gets their trigger method called when this class trigger method is called.

Parameters:: args (EventObserver) – One or more observers to add.
Return type:: None

Note

Observers are removed automatically when they are out of scope.

add_event_paint_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_properties_change(names, cb)

Add properties to listen for changes.

Parameters:

names (Iterable[str]) – One or more property names to listen for changes.
cb (EventArgsCallbackT) – Callback that is invoked when an event is triggered.

Raises:

ValueError – If names is empty.

Return type:

None

Note

The callback EventArgs.event_data will contain a tuple of com.sun.star.beans.PropertyChangeEvent objects.

Each time this method is called, the previous names are removed and the new names are added.

add_event_property_change(name, cb)

Adds a listener for an event.

Event is invoked when property is changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_property_change_events_disposing(name, cb)

Adds a listener for an event.

Event is invoked when the property listener is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_top_window_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_vetoable_change(name, cb)

Adds a listener for an event.

Event is invoked when property is changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_vetoable_change_events_disposing(name, cb)

Adds a listener for an event.

Event is invoked when the property listener is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_window_activated(cb)

Adds a listener for an event.

Event is invoked when a window is activated.

The callback EventArgs.event_data will contain a UNO com.sun.star.langEventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_closed(cb)

Adds a listener for an event.

Event is invoked when a window has been closed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_closing(cb)

Adds a listener for an event.

Event is invoked when a window is in the process of being closed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_deactivated(cb)

Adds a listener for an event.

Event is invoked when a window is deactivated.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_hidden(cb)

Adds a listener for an event.

Event is invoked when the window has been hidden.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_minimized(cb)

Adds a listener for an event.

Event is invoked when a window is iconified.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_moved(cb)

Adds a listener for an event.

Event is invoked when the window has been moved.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_normalized(cb)

Adds a listener for an event.

Event is invoked when a window is deiconified.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_opened(cb)

Adds a listener for an event.

Event is invoked when a window has been opened.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_paint(cb)

Adds a listener for an event.

Event Is invoked when a region of the window became invalid, e.g. when another window has been moved away.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.PaintEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_resized(cb)

Adds a listener for an event.

Event is invoked when the window has been resized.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_shown(cb)

Adds a listener for an event.

Event is invoked when the window has been shown.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_focus_listener(listener)

Adds a focus listener to the object.

Return type:: None
Parameters:: listener (com.sun.star.awt.XFocusListener) –

add_key_listener(listener)

Adds a key listener to the object.

Return type:: None
Parameters:: listener (com.sun.star.awt.XKeyListener) –

add_mouse_listener(listener)

Adds a mouse listener to the object.

Return type:: None
Parameters:: listener (com.sun.star.awt.XMouseListener) –

add_mouse_motion_listener(listener)

Adds a mouse motion listener to the object.

Return type:: None
Parameters:: listener (com.sun.star.awt.XMouseMotionListener) –

add_paint_listener(listener)

Adds a paint listener to the object.

Return type:: None
Parameters:: listener (com.sun.star.awt.XPaintListener) –

add_top_window_listener(listener)

Adds the specified top window listener to receive window events from this window.

Return type:: None
Parameters:: listener (com.sun.star.awt.XTopWindowListener) –

add_window_listener(listener)

Adds a window listener to the object.

Return type:: None
Parameters:: listener (com.sun.star.awt.XWindowListener) –

convert_point_to_logic(point, target_unit)

Converts the given Point, which is specified in pixels, into the given logical unit.

Raises:

com.sun.star.lang.IllegalArgumentException – IllegalArgumentException.

Returns:

Converted Point

Return type:

Point

Parameters:

point (Point) –
target_unit (int | MeasureUnitEnum) –

Hint

MeasureUnitEnum can be imported from ooo.dyn.util.measure_unit

convert_point_to_pixel(point, source_unit)

Converts the given Point, which is specified in the given logical unit, into pixels.

Raises:

com.sun.star.lang.IllegalArgumentException – IllegalArgumentException.

Returns:

Converted Point

Return type:

Point

Parameters:

point (Point) –
source_unit (int | MeasureUnitEnum) –

Hint

MeasureUnitEnum can be imported from ooo.dyn.util.measure_unit

convert_size_to_logic(size, target_unit)

Converts the given Size, which is specified in pixels, into the given logical unit.

Raises:

com.sun.star.lang.IllegalArgumentException – IllegalArgumentException.

Returns:

Converted Point

Return type:

Point

Parameters:

size (Size) –
target_unit (int | MeasureUnitEnum) –

Hint

MeasureUnitEnum can be imported from ooo.dyn.util.measure_unit

convert_size_to_pixel(size, source_unit)

Converts the given Size, which is specified in the given logical unit, into pixels.

Raises:

com.sun.star.lang.IllegalArgumentException – IllegalArgumentException.

Returns:

Converted Point

Return type:

Point

Parameters:

size (Size) –
source_unit (int | MeasureUnitEnum) –

Hint

MeasureUnitEnum can be imported from ooo.dyn.util.measure_unit

create_peer() → None[source]

create_peer(toolkit: com.sun.star.awt.XToolkit) → None

create_peer(*, parent: com.sun.star.awt.XWindowPeer) → None

create_peer(toolkit: com.sun.star.awt.XToolkit, parent: com.sun.star.awt.XWindowPeer) → None

create_peer(toolkit=None, parent=None)

Creates a child window on the screen.

If the parent is None, then the desktop window of the toolkit is the parent.

Parameters:

toolkit (XToolkit, optional) – The toolkit to use. Defaults to None.
parent (XWindowPeer, optional) – The parent window. Defaults to None.

Return type:

None

dispose()[source]

Disposes the dialog

Return type:: None

end_dialog(result)

Hides the dialog and then causes XDialog.execute() to return with the given result value.

Return type:: None
Parameters:: result (int) –

end_execute()

Hides the dialog and then causes XDialog.execute() to return.

Return type:: None

execute()

Runs the dialog modally: shows it, and waits for the execution to end.

Returns an exit code (e.g., indicating the button that was used to end the execution).

Return type:: int

find_control(name)[source]

Finds control by name

Parameters:: name (str) – Name to find
Returns:: Control
Return type:: XControl

fire_event_properties_change(names)

Fires a sequence of PropertyChangeEvents

Parameters:: names (Iterable[str]) – Sequence of property names to fire event for.
Return type:: None

get_context()

Gets the context of the control.

Return type:: XInterface

get_control(name)

Returns the control with the specified name.

Return type:: XControl
Parameters:: name (str) –

get_control_props()

Gets property set for a control model

Parameters:: control_model (Any) – control model
Returns:: Property set
Return type:: XPropertySet | None

get_controls()

Returns all controls.

Return type:: Tuple[XControl, ...]

get_dialog_controls_arr()[source]

Gets all controls for the dialog

Returns:: controls
Return type:: Tuple[XControl, …]

get_model()[source]

Gets the Model for the control

Return type:: UnoControlDialogModel

get_peer()

Gets the peer which was previously created or set.

Return type:: XWindowPeer

get_pos_size()

Gets the outer bounds of the window.

Return type:: Rectangle

get_property_set()

Gets the property set for this control

Return type:: XPropertySet

get_title()

Gets the title of the dialog.

Return type:: str

get_uno_srv_name()[source]

Returns com.sun.star.awt.UnoControlDialog

Return type:: str

get_view()[source]

Gets the view of this control.

Return type:: UnoControlDialog

get_view_ctl()

Return type:: XControl

is_design_mode()

Returns True if the control is in design mode, False otherwise.

Return type:: bool

is_transparent()

Returns True if the control is transparent, False otherwise.

Return type:: bool

remove_control(ctl)

Removes the given control from the container.

Return type:: None
Parameters:: ctl (com.sun.star.awt.XControl) –

remove_event_focus_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_focus_gained(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_focus_lost(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_key_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_key_pressed(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_key_released(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_listener(listener)

Removes an event listener from the component.

Parameters:: listener (XEventListener) – The event listener to be removed.
Return type:: None

remove_event_mouse_dragged(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_entered(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_exited(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_motion_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_moved(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_pressed(cb)

Removes a listener for an event.

Event is invoked when a mouse button has been pressed on a window.

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_released(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_observer(observer)

Removes an observer

Parameters:: observer (EventObserver) – One or more observers to add.
Returns:: True if observer has been removed; Otherwise, False.
Return type:: bool

remove_event_paint_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_properties_listener()

Remove Properties Listener

Return type:: None

remove_event_property_change(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_property_change_events_disposing(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_top_window_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_vetoable_change(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_vetoable_change_events_disposing(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_window_activated(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_window_closed(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_window_closing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_window_deactivated(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_window_events_disposing(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_hidden(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_minimized(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_window_moved(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_normalized(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_window_opened(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_window_paint(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_window_resized(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_shown(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_focus_listener(listener)

Removes the specified focus listener from the listener list.

Return type:: None
Parameters:: listener (com.sun.star.awt.XFocusListener) –

remove_key_listener(listener)

Removes the specified key listener from the listener list.

Return type:: None
Parameters:: listener (com.sun.star.awt.XKeyListener) –

remove_mouse_listener(listener)

Removes the specified mouse listener from the listener list.

Return type:: None
Parameters:: listener (com.sun.star.awt.XMouseListener) –

remove_mouse_motion_listener(listener)

Removes the specified mouse motion listener from the listener list.

Return type:: None
Parameters:: listener (com.sun.star.awt.XMouseMotionListener) –

remove_paint_listener(listener)

Removes the specified paint listener from the listener list.

Return type:: None
Parameters:: listener (com.sun.star.awt.XPaintListener) –

remove_top_window_listener(listener)

Removes the specified top window listener so that it no longer receives window events from this window.

Return type:: None
Parameters:: listener (com.sun.star.awt.XTopWindowListener) –

remove_window_listener(listener)

Removes the specified window listener from the listener list.

Return type:: None
Parameters:: listener (com.sun.star.awt.XWindowListener) –

set_context(ctx)

Sets the context of the control.

Return type:: None
Parameters:: ctx (com.sun.star.uno.XInterface) –

set_design_mode(on)

Sets the design mode for use in a design editor.

Normally the control will be painted directly without a peer.

Return type:: None
Parameters:: on (bool) –

set_enable(enable)

Enables or disables the window depending on the parameter.

Return type:: None
Parameters:: enable (bool) –

set_focus()

sets the focus to the window.

Return type:: None

set_help_id(help_id)

Sets the help id so that the standard help button action will show the appropriate help page.

Return type:: None
Parameters:: help_id (str) –

set_menu_bar(menu)

Sets a menu bar.

Return type:: None
Parameters:: menu (com.sun.star.awt.XMenuBar) –

set_model(model)

Sets a model for the control.

Return type:: bool
Parameters:: model (com.sun.star.awt.XControlModel) –

set_pos_size(x, y, width, height, flags=15)[source]

Sets the outer bounds of the window.

Parameters:

x (int, UnitT) – The x-coordinate of the window. In Pixels or UnitT.
y (int, UnitT) – The y-coordinate of the window. In Pixels or UnitT.
width (int, UnitT) – The width of the window. In Pixels or UnitT.
height (int, UnitT) – The height of the window. In Pixels or UnitT.
flags (int, UnitT) – A combination of com.sun.star.awt.PosSize flags. Default set to PosSize.POSSIZE.

Return type:

None

Note

The Model is in AppFont units where as the View is in Pixels. The values are converted from Pixels to AppFont units and assigned to the model. If the values are passed in as UnitAppFontX, UnitAppFontY, UnitAppFontWidth, or UnitAppFontHeight then they are assigned directly to the model without conversion.

set_status_text(text)

Sets the status text in the status bar of the container.

Return type:: None
Parameters:: text (str) –

set_title(title)

sets the title of the dialog.

Return type:: None
Parameters:: title (str) –

set_visible(visible)

Shows or hides the window depending on the parameter.

Return type:: None
Parameters:: visible (bool) –

subscribe_event(event_name, callback)

Add an event listener to current instance.

Parameters:

event_name (str) – Event Name.
callback (EventCallback) – Callback of the event listener.

Return type:

None

to_back()

Places this window at the bottom of the stacking order and makes the corresponding adjustment to other visible windows.

Return type:: None

to_front()

Places this window at the top of the stacking order and shows it in front of any other windows.

Return type:: None

trigger_event(event_name, event_args)

Trigger an event on current instance.

Parameters:

event_name (str) – Event Name.
event_args (EventArgsT) – Event Args.

Return type:

None

unsubscribe_event(event_name, callback)

Remove an event listener from current instance.

Parameters:

event_name (str) – Event Name.
callback (EventCallback) – Callback of the event listener.

Return type:

None

property component: com.sun.star.awt.UnoControlDialog

UnoControlDialog Component

Return type:: UnoControlDialog

property control: com.sun.star.awt.UnoControlDialog

Returns the control

Return type:: UnoControlDialog

property event_observer: EventObserver

Gets/Sets The Event Observer for this instance.

Return type:: EventObserver

property events_listener_focus: FocusListener

Returns listener

Return type:: FocusListener

property events_listener_key: KeyListener

Returns listener

Return type:: KeyListener

property events_listener_mouse: MouseListener

Returns listener

Return type:: MouseListener

property events_listener_mouse_motion: MouseMotionListener

Returns listener

Return type:: MouseMotionListener

property events_listener_paint: PaintListener

Returns listener

Return type:: PaintListener

property events_listener_properties_change_implement: PropertiesChangeListener

Returns listener

Return type:: PropertiesChangeListener

property events_listener_top_window: TopWindowListener

Returns listener

Return type:: TopWindowListener

property events_listener_window: WindowListener

Returns listener

Return type:: WindowListener

property height: UnitPX

Gets/Sets the height of the control in Pixel units.

When setting can be an integer in Pixels Units or a UnitT.

Returns:: Height of the control.
Return type:: UnitPX

Note

The Height is in Pixel units; however, the model is in AppFont units. This property will convert the AppFont units to Pixel units. When set using UnitAppFontHeight no conversion is done.

property lo_inst: LoInst

Lo Instance

Return type:: LoInst

property model: com.sun.star.awt.UnoControlModel

Uno Control Model

Return type:: UnoControlModel

property model_ex: ModelDialog

Gets the extended Model for the control.

This is a wrapped instance for the model property. It add some additional properties and methods to the model.

Return type:: ModelDialog

property name: str

Gets/Sets the name of the control.

Return type:: str

property step: int

Gets/Sets the step of the control.

Return type:: int

property tab_index: int

Gets/Sets the tab index of the control.

Return type:: int

property tag: str

Gets/Sets the tag of the control.

Return type:: str

property title: str

Gets the title of the dialog

Return type:: str

property view: com.sun.star.awt.UnoControl

Uno Control

Return type:: UnoControl

property visible: bool

Gets/Sets the visible state for the control

Return type:: bool

property width: UnitPX

Gets the width of the control

Return type:: UnitPX

property x: UnitPX

Gets/Sets the X position for the control in pixel units.

When setting can be an integer in Pixels Units or a UnitT.

Returns:: X position of the control.
Return type:: UnitPX

Note

The X is in Pixel units; however, the model is in AppFont units. This property will convert the AppFont units to Pixel units. When set using UnitAppFontX no conversion is done.

property y: UnitPX

Gets/Sets the Y position for the control in pixel units.

When setting can be an integer in Pixels Units or a UnitT.

Returns:: Y position of the control.
Return type:: UnitPX

Note

The Y is in Pixel units; however, the model is in AppFont units. This property will convert the AppFont units to Pixel units. When set using UnitAppFontY no conversion is done.