Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: frame ::
unpublished | interface XModel2 |
  Base Interfaces
      XModel2
      ┗ XModel
         ┗ ::com::sun::star::lang::XComponent
  XModel | (referenced interface's summary:) represents a component which is created from an URL and arguments.
Usage Restrictions not published Description extends interface XModel. The following functions are added: - enumeration of all currently connected controller objects. (not getCurrentController() only, which depends on focus) - establish new view controller factory methods, which will make it possible to create new views for this model.

Methods' Summary
getControllers | provides list of all currently connected controller objects.
getAvailableViewControllerNames | provides the available names of the factory to be used to create views.
createDefaultViewController | creates the default view instance for this model.
createViewController | creates a new view instance classified by the specified name and arguments.

Methods' Details
getControllers
::com::sun::star::container::XEnumeration
getControllers();
Description provides list of all currently connected controller objects. Please note: Because this interface will might be used inside multi threaded environments those list can contain still disposed items or it new added controller will be missing (if they was added after this enumeration was created). Returns list of controller objects. Enumeration can be empty but not NULL.
getAvailableViewControllerNames
sequence< string >
getAvailableViewControllerNames();
Description provides the available names of the factory to be used to create views. The names are usually logical view names. The following names have a defined meaning, i.e. every concrete implementation which returns such a name must ensure it has the same meaning, and if a concrete implementation has a view with the given meaning, it must give it the name as defined here: Default specifies the default view of the document. Preview specifies a preview of the document. A minimal implementation of such a view is a Default view which is read-only. PrintPreview specifies a print preview of the document. Implementations of this interface might decide to support additional view names, which then are documented in the respective service descriptions. Returns a sequence of names of all supported views for this document. See also createView
createDefaultViewController
XController2
createDefaultViewController( | [in] XFrame | Frame )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::Exception );
Description creates the default view instance for this model. Effectively, this method is equivalent to calling createView with the `ViewName` being `"Default"`. Parameter Frame used to place the new created view there Returns the new view controller instance Throws ::com::sun::star::lang::IllegalArgumentException if one of the given parameter was wrong Throws ::com::sun::star::uno::Exception if creation of a new view failed by other reasons
createViewController
XController2
createViewController( | [in] string | ViewName,
| [in] sequence< ::com::sun::star::beans::PropertyValue > | Arguments,
| [in] XFrame | Frame )
raises( | ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::Exception );
Description creates a new view instance classified by the specified name and arguments. The newly created controller must not be connected with the document and the frame. That is, you should neither call XFrame::setComponent, nor XController::attachFrame, nor XController::attachModel, nor XModel::connectController, not XModel::setCurrentController. All of this is the responsibility of the caller, which will do it in the proper order. Parameter ViewName classified name of instance Parameter Arguments arguments used for creation Parameter Frame used to place the new created view there Returns the new view controller instance Throws ::com::sun::star::lang::IllegalArgumentException if one of the given parameter was wrong Throws ::com::sun::star::uno::Exception if creation of a new view failed by other reasons

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.