LibreOffice
LibreOffice 24.2 SDK API Reference
Public Member Functions | List of all members
XWindow Interface Referencepublished

specifies the basic operations for a window component. More...

import"XWindow.idl";

Inheritance diagram for XWindow:
XComponent XInterface UnoControl XUnoControlDialog XWindow2 DrawingDocumentDrawView XPlayerWindow OutlineView PresentationView PreviewView SlidesView

Public Member Functions

void setPosSize ([in] long X, [in] long Y, [in] long Width, [in] long Height, [in] short Flags)
 sets the outer bounds of the window. More...
 
com::sun::star::awt::Rectangle getPosSize ()
 returns the outer bounds of the window. More...
 
void setVisible ([in] boolean Visible)
 shows or hides the window depending on the parameter. More...
 
void setEnable ([in] boolean Enable)
 enables or disables the window depending on the parameter. More...
 
void setFocus ()
 sets the focus to the window. More...
 
void addWindowListener ([in] com::sun::star::awt::XWindowListener xListener)
 adds a window listener to the object. More...
 
void removeWindowListener ([in] com::sun::star::awt::XWindowListener xListener)
 removes the specified window listener from the listener list. More...
 
void addFocusListener ([in] com::sun::star::awt::XFocusListener xListener)
 adds a focus listener to the object. More...
 
void removeFocusListener ([in] com::sun::star::awt::XFocusListener xListener)
 removes the specified focus listener from the listener list. More...
 
void addKeyListener ([in] com::sun::star::awt::XKeyListener xListener)
 adds a key listener to the object. More...
 
void removeKeyListener ([in] com::sun::star::awt::XKeyListener xListener)
 removes the specified key listener from the listener list. More...
 
void addMouseListener ([in] com::sun::star::awt::XMouseListener xListener)
 adds a mouse listener to the object. More...
 
void removeMouseListener ([in] com::sun::star::awt::XMouseListener xListener)
 removes the specified mouse listener from the listener list. More...
 
void addMouseMotionListener ([in] com::sun::star::awt::XMouseMotionListener xListener)
 adds a mouse motion listener to the object. More...
 
void removeMouseMotionListener ([in] com::sun::star::awt::XMouseMotionListener xListener)
 removes the specified mouse motion listener from the listener list. More...
 
void addPaintListener ([in] com::sun::star::awt::XPaintListener xListener)
 adds a paint listener to the object. More...
 
void removePaintListener ([in] com::sun::star::awt::XPaintListener xListener)
 removes the specified paint listener from the listener list. More...
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

specifies the basic operations for a window component.

A window is a rectangular region on an output device with its own position, size, and internal coordinate system. A window is used for displaying data. In addition, the window receives events from the user.

Developers Guide
Office Development - Component - Window Interfaces
Office Development - Frames - Linking Components and Windows
Office Development - Windows

Member Function Documentation

◆ addFocusListener()

void addFocusListener ( [in] com::sun::star::awt::XFocusListener  xListener)

adds a focus listener to the object.

◆ addKeyListener()

void addKeyListener ( [in] com::sun::star::awt::XKeyListener  xListener)

adds a key listener to the object.

◆ addMouseListener()

void addMouseListener ( [in] com::sun::star::awt::XMouseListener  xListener)

adds a mouse listener to the object.

◆ addMouseMotionListener()

void addMouseMotionListener ( [in] com::sun::star::awt::XMouseMotionListener  xListener)

adds a mouse motion listener to the object.

◆ addPaintListener()

void addPaintListener ( [in] com::sun::star::awt::XPaintListener  xListener)

adds a paint listener to the object.

◆ addWindowListener()

void addWindowListener ( [in] com::sun::star::awt::XWindowListener  xListener)

adds a window listener to the object.

Parameters
xListenerthe listener to add. If this listener also supports the XWindowListener2 interface, it will receive the additional events declared in XWindowListener2.

◆ getPosSize()

returns the outer bounds of the window.

◆ removeFocusListener()

void removeFocusListener ( [in] com::sun::star::awt::XFocusListener  xListener)

removes the specified focus listener from the listener list.

◆ removeKeyListener()

void removeKeyListener ( [in] com::sun::star::awt::XKeyListener  xListener)

removes the specified key listener from the listener list.

◆ removeMouseListener()

void removeMouseListener ( [in] com::sun::star::awt::XMouseListener  xListener)

removes the specified mouse listener from the listener list.

◆ removeMouseMotionListener()

void removeMouseMotionListener ( [in] com::sun::star::awt::XMouseMotionListener  xListener)

removes the specified mouse motion listener from the listener list.

◆ removePaintListener()

void removePaintListener ( [in] com::sun::star::awt::XPaintListener  xListener)

removes the specified paint listener from the listener list.

◆ removeWindowListener()

void removeWindowListener ( [in] com::sun::star::awt::XWindowListener  xListener)

removes the specified window listener from the listener list.

◆ setEnable()

void setEnable ( [in] boolean  Enable)

enables or disables the window depending on the parameter.

◆ setFocus()

void setFocus ( )

sets the focus to the window.

◆ setPosSize()

void setPosSize ( [in] long  X,
[in] long  Y,
[in] long  Width,
[in] long  Height,
[in] short  Flags 
)

sets the outer bounds of the window.

Parameters
Xthe x-coordinate of the window.
Ythe y-coordinate of the window.
Widththe width of the window.
Heightthe height of the window.
FlagsFlags are of type PosSize and specify, which parameters are taken into account when setting the outer bounds of the window.

◆ setVisible()

void setVisible ( [in] boolean  Visible)

shows or hides the window depending on the parameter.


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