UI Layout Control API

Module: mls.ui. This page documents 9 public functions with exact tool IDs, complete parameters, Parameters fields, and examples.

Back to the Script Tool API Reference

Functions

set_dock_visibility

Show or hide a dock widget

  • Exact tool ID:ui_set_dock_visibility
  • Recommended call:mls.ui.set_dock_visibility(...)
  • Required parameters:dock_id, visible

Parameters

Parameter Type Required Default Description
dock_id string Yes — Dock widget ID
visible boolean Yes — Show or hide

Example

from gvscript import mls

result = mls.ui.set_dock_visibility(
    dock_id='example_id',
    visible=True,
)
print(result.ok, result.output, result.message)

set_toolbar_visibility

Show or hide a toolbar

  • Exact tool ID:ui_set_toolbar_visibility
  • Recommended call:mls.ui.set_toolbar_visibility(...)
  • Required parameters:toolbar_id, visible

Parameters

Parameter Type Required Default Description
toolbar_id string Yes — Toolbar ID
visible boolean Yes — Show or hide

Example

from gvscript import mls

result = mls.ui.set_toolbar_visibility(
    toolbar_id='example_id',
    visible=True,
)
print(result.ok, result.output, result.message)

set_ribbon_page_visibility

Show or hide a ribbon page

  • Exact tool ID:ui_set_ribbon_page_visibility
  • Recommended call:mls.ui.set_ribbon_page_visibility(...)
  • Required parameters:page_id, visible

Parameters

Parameter Type Required Default Description
page_id string Yes — Ribbon page ID
visible boolean Yes — Show or hide

Example

from gvscript import mls

result = mls.ui.set_ribbon_page_visibility(
    page_id='example_id',
    visible=True,
)
print(result.ok, result.output, result.message)

activate_dock

Activate and bring focus to a dock widget

  • Exact tool ID:ui_activate_dock
  • Recommended call:mls.ui.activate_dock(...)
  • Required parameters:dock_id

Parameters

Parameter Type Required Default Description
dock_id string Yes — Dock widget ID

Example

from gvscript import mls

result = mls.ui.activate_dock(
    dock_id='example_id',
)
print(result.ok, result.output, result.message)

reset_layout

Reset UI layout to default

  • Exact tool ID:ui_reset_layout
  • Recommended call:mls.ui.reset_layout(...)
  • Required parameters: None

Parameters

Parameter Type Required Default Description
— — — — This function does not accept any function-specific parameters.

Example

from gvscript import mls

result = mls.ui.reset_layout(
)
print(result.ok, result.output, result.message)

get_layout_state

Get current UI layout state

  • Exact tool ID:ui_get_layout_state
  • Recommended call:mls.ui.get_layout_state(...)
  • Required parameters: None

Parameters

Parameter Type Required Default Description
— — — — This function does not accept any function-specific parameters.

Example

from gvscript import mls

result = mls.ui.get_layout_state(
)
print(result.ok, result.output, result.message)

get_component_visibility

Get visibility status of UI components

  • Exact tool ID:ui_get_component_visibility
  • Recommended call:mls.ui.get_component_visibility(...)
  • Required parameters:component_id

Parameters

Parameter Type Required Default Description
component_id string Yes — Component ID to query
component_type string No 'dock' Component type: dock, toolbar, or ribbon

Example

from gvscript import mls

result = mls.ui.get_component_visibility(
    component_id='example_id',
    component_type='dock',
)
print(result.ok, result.output, result.message)

set_start_page_visibility

Show or hide the start page

  • Exact tool ID:ui_set_start_page_visibility
  • Recommended call:mls.ui.set_start_page_visibility(...)
  • Required parameters:visible

Parameters

Parameter Type Required Default Description
visible boolean Yes — Show or hide start page

Example

from gvscript import mls

result = mls.ui.set_start_page_visibility(
    visible=True,
)
print(result.ok, result.output, result.message)

get_start_page_visibility

Get start page visibility status

  • Exact tool ID:ui_get_start_page_visibility
  • Recommended call:mls.ui.get_start_page_visibility(...)
  • Required parameters: None

Parameters

Parameter Type Required Default Description
— — — — This function does not accept any function-specific parameters.

Example

from gvscript import mls

result = mls.ui.get_start_page_visibility(
)
print(result.ok, result.output, result.message)

results matching ""

    No results matching ""