LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XPane2 Interface Reference

An extension of the XPane interface that adds support for a) showing and hiding the windows that internally belong to the pane and b) setting the accessibility object. More...

import"XPane2.idl";

Public Member Functions

boolean isVisible ()
 Return whether all windows that are used to implement the pane are visible. More...
 
void setVisible ([in] boolean bIsVisible)
 Hide or show the pane. More...
 
void setAccessible ([in]::com::sun::star::accessibility::XAccessible xAccessible)
 Set the accessibility object for the pane. More...
 
::com::sun::star::accessibility::XAccessible getAccessible ()
 Return the accessibility object that is currently associated with the windows that implement the pane. More...
 

Detailed Description

An extension of the XPane interface that adds support for a) showing and hiding the windows that internally belong to the pane and b) setting the accessibility object.

This is typically an optional interface.

Member Function Documentation

Return the accessibility object that is currently associated with the windows that implement the pane.

boolean isVisible ( )

Return whether all windows that are used to implement the pane are visible.

Returns
TRUE when all windows of the pane are visible.
void setAccessible ( [in] ::com::sun::star::accessibility::XAccessible  xAccessible)

Set the accessibility object for the pane.

When there is more than one window used to implement the pane then the given accessibility object is usually set at the topmost window. However, the details are implementation dependent.

Parameters
xAccessibleMay be an empty reference.
void setVisible ( [in] boolean  bIsVisible)

Hide or show the pane.

If there is more than one window used to implement the pane then it is left to the implementation if one, some, or all windows are hidden or shown as long as the pane becomes hidden or visible.

Parameters
bIsVisibleWhen TRUE then show the pane. Hide it otherwise.

The documentation for this interface was generated from the following file: