Class ViewComboBox

class ooodev.dialog.dl_control.view.view_combo_box.ViewComboBox(component)[source]

Bases: UnoControlComboBoxComp

View for the Combo box control.

Parameters:: component (UnoControlComboBox) –

__init__(component)

Constructor

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

add_action_listener(listener)

registers a listener for action events.

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

add_event_listener(listener)

Adds an event listener to the component.

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

add_focus_listener(listener)

Adds a focus listener to the object.

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

add_item(item, pos)

Adds an item at the specified position.

Return type:

None

Parameters:

item (str) –
pos (int) –

add_item_listener(listener)

Registers a listener for item events.

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

add_items(pos, *items)

Adds multiple items at the specified position.

Return type:

None

Parameters:

pos (int) –
items (str) –

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_text_listener(listener)

Registers a text event listener.

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

add_window_listener(listener)

Adds a window listener to the object.

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

calc_adjusted_size(width, height)

Calculates the adjusted size for a given maximum size.

Parameters:

width (int | UnitT) – Width. If int then pixel units.
height (int | UnitT) – Height. If int then pixel units.

Returns:

Adjusted size in pixel units.

Return type:

SizePX

create_peer(toolkit, parent)

Creates a child window on the screen.

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

Return type:

None

Parameters:

toolkit (com.sun.star.awt.XToolkit) –
parent (com.sun.star.awt.XWindowPeer) –

dispose()

Disposes the component.

Return type:: None

draw(x, y)

Draws the object at the specified position.

If the output should be clipped, the caller has to set the clipping region.

Parameters:

x (int | UnitT) – X coordinate in device units. If int then pixel units.
y (int | UnitT) – Y coordinate in device units. If int then pixel units.

Return type:

None

get_columns_and_lines()

Returns the ideal number of columns and lines for displaying this text.

Returns:: Number of columns and lines.
Return type:: Tuple[int, int]

get_context()

Gets the context of the control.

Return type:: XInterface

get_drop_down_line_count()

Returns the number of visible lines in the drop down mode.

Return type:: int

get_graphics()

Gets the output device which was set using the method XView.setGraphics().

Return type:: XGraphics

get_item(pos)

Gets the item at the specified position.

Return type:: str
Parameters:: pos (int) –

get_item_count()

Gets the number of items in the combo box.

Return type:: int

get_items()

Gets all items of the combo box.

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

get_max_text_len()

Gets the currently set maximum text length.

Return type:: int

get_minimum_size()

Gets the minimum size for this component.

Returns:: Minimum size in pixel units.
Return type:: SizePX

Note

Use get_minimum_size_text_layout() to get the minimum size for a given number of columns and lines.

get_minimum_size_text_layout(cols, lines)

Returns the minimum size for a given number of columns and lines.

Return type:

SizePX

Parameters:

cols (int) –
lines (int) –

get_model()

Gets the model for this control.

Return type:: XControlModel

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:: SizePosPX

get_preferred_size()

Gets the preferred size for this component.

Returns:: Preferred size in pixel units.
Return type:: SizePX

get_selected_text()

Gets the currently selected text.

Return type:: str

get_selection()

Gets the current user selection.

Return type:: Selection

get_size()

Gets the size of the object in device units.

A device must be set before.

Returns:: Size of the object in pixel units.
Return type:: SizePX

get_text()

Gets the text of the component.

Return type:: str

get_view()

Gets the view of this control.

Return type:: XView

insert_text(sel, text)

Inserts text at the specified position.

Return type:

None

Parameters:

sel (com.sun.star.awt.Selection) –
text (str) –

Hint

Selection can be imported from ooo.dyn.awt.selection.

is_design_mode()

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

Return type:: bool

is_editable()

Gets if the text is editable by the user.

Return type:: bool

is_transparent()

Returns True if the control is transparent, False otherwise.

Return type:: bool

remove_action_listener(listener)

Un-registers a listener for action events.

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

remove_event_listener(listener)

Removes an event listener from the component.

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

remove_focus_listener(listener)

Removes the specified focus listener from the listener list.

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

remove_item_listener(listener)

Un-registers a listener for item events.

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

remove_items(pos, count)

Removes a number of items at the specified position.

Return type:

None

Parameters:

pos (int) –
count (int) –

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_text_listener(listener)

Un-registers a text event listener.

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

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_drop_down_line_count(lines)

Sets the number of visible lines for drop down mode.

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

set_editable(editable)

Makes the text editable for the user or read-only.

Return type:: None
Parameters:: editable (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_graphics(device)

Sets the output device.

Return type:: bool
Parameters:: device (com.sun.star.awt.XGraphics) –

set_max_text_len(length)

Sets the maximum text length.

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

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)

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