Interface XObjectInspector

Content for Apache OpenOffice version 3.4.

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

:: com :: sun :: star :: inspection ::

interface XObjectInspector

Base Interfaces

XObjectInspector
┣ ::com::sun::star::frame::XController
┃ ┗ ::com::sun::star::lang::XComponent
┗ ::com::sun::star::frame::XDispatchProvider

::com::sun::star::frame::XController

Description

allows to plug the inspector into an ::com::sun::star::frame::XFrame

The ::com::sun::star::frame::XController::setModel method accepts only XObjectInspectorModels, and will return false if the to-be-attached model is not NULL, but does not support this interface.

If you do not want to support a full-blown ::com::sun::star::frame::XModel, use the InspectorModel attribute instead.

The ::com::sun::star::frame::XController::getViewData and ::com::sun::star::frame::XController::restoreViewData exchange string values, which describes as much of the current view state as possible.

::com::sun::star::frame::XDispatchProvider

Description: allows to intercept functionality; This interface is inherited from the ::com::sun::star::frame::Controller service, currently, there is no functionality to intercept at an XObjectInspector.

Description: describes the main interface of an ObjectInspector.
Since: OOo 2.0.3
See also: ObjectInspector

Methods' Summary
inspect	inspects a new collection of one or more objects.

Attributes' Summary
InspectorModel	provides access to the current model of the inspector
InspectorUI	provides access to the user interface of the object inspector.

Methods' Details

inspect

void
inspect(	[in] sequence< ::com::sun::star::uno::XInterface >	Objects )
raises(	::com::sun::star::util::VetoException );

Description

inspects a new collection of one or more objects.

If the sequence is empty, the UI of the ObjectInspector will be cleared.

If the sequence contains more than one object, the XObjectInspector will create a complete set of property handlers (as indicated by XObjectInspectorModel::HandlerFactories) for every of the objects, and compose their output.

Throws

com::sun::star::util::VetoException if the inspector cannot switch to another object set. This typically happens if one of the active XPropertyHandler's raised a non-modal user interface, and vetoed suspension of this UI.

Attributes' Details

InspectorModel

XObjectInspectorModel InspectorModel; Description provides access to the current model of the inspector The model is mainly responsible for providing the property handlers. Additionally, it can provide user interface names and help URLs for property categories. Note that there are two ways of setting or retrieving the current model: You can either use ::com::sun::star::frame::XModel::setModel, or, if you do not want or need to implement the full-blown ::com::sun::star::frame::XModel interface, you can use this property directly. Both approaches are semantically equivalent. If a new model is set at the inspector, the complete UI will be rebuilt to reflect the change, using the new property handlers provided by the new model.

InspectorUI

[ readonly ] XObjectInspectorUI InspectorUI; Description provides access to the user interface of the object inspector. This interface can be used to access and manipulate various aspects of the user interface. For instance, you can enable and disable certain property controls (or parts thereof), or register observers for all property controls. Since OOo 2.2

Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous