View source for UNO automation with a binary (executable)

From Apache OpenOffice Wiki

← UNO automation with a binary (executable)

You do not have permission to edit this page, for the following reasons:

• The action you have requested is limited to users in the group: Users.
• You must confirm your email address before editing pages. Please set and validate your email address through your user preferences.

---

You can view and copy the source of this page.

{{DocBanner}} {{NeedsRework|EN}} We want now discuss a fully UNO/OpenOffice program : we mean a program which automates some tasks on {{AOo}} documents, file loading, file modifying, file saving... all in all “Create a binary program to replace a OOBasic program”. The border between the examples of previous chapter and of this chapter is vague. I can only say : if you imagine to automate any problem and create a program for it, this paragraph and the next chapters are for you. Please read also [[Documentation/BASIC_Guide/API_Intro|Introduction to the {{AOo}} API]] and documentation [[Documentation/DevGuide/WritingUNO/Required_Files|on necessary tools for UNO development]] in Developer's Guide. = Introduction : starting from a SDK example= == Introduction to services and interfaces== Before going further, I have to explain the minimal organization of UNO API, particularly of the distinction between services and interfaces. A service is a set of interfaces. Both have a name starting with "com.sun.star" followed by a module's name ".lang" for instance and terminate with the effective service or interface name. An interface name begins always with a 'X' character. For instance, <idl>com.sun.star.lang.ServiceManager</idl> is a service and clicking on the link shows you it contains many interfaces, and <idl>com.sun.star.lang.XServiceInfo</idl> is one of them (name starting with a X). See also [[Documentation/BASIC_Guide/API_Intro|UNO API]] in {{AOo}} Basic document and [[Documentation/DevGuide/FirstSteps/Objects%2C_Interfaces%2C_and_Services|Developer's Guide]]. ==ServiceManager and Desktop objects == Danny Brewer wrote in the [https://web.archive.org/web/20070119064730/http://www.oooforum.org/forum/viewtopic.phtml?t=5252 oooforum.org] : {{Citation|To do almost anything useful with {{AOo}} via the API, in almost all cases, you must either create a new document, or open an existing document. Then you would manipulate the contents of the document, extract information from it, print it, convert it to a different format, work with data forms on the document, or perform various other tasks with office documents. Therefore, one of the first things to learn is how to open or create documents. In order to work with {{AOo}} through the API, you must first acquire two essential objects. # the <idl>com.sun.star.lang.ServiceManager</idl> # the <idl>com.sun.star.frame.Desktop</idl> Once you have the <code>ServiceManager</code>, you call its createInstance() method to get the <code>Desktop</code> object. Once you have the <code>Desktop</code> object, you can use it to create or open new documents.}} More on <idl>com.sun.star.frame.Desktop</idl> service [[Documentation/BASIC_Guide/StarDesktop|here in OOoBasic Guide]]. == Getting the Service Manager == In every different programming language, there are different mechanisms for acquiring the Service Manager. One way of getting the service manager is given in one SDK example : <OpenOffice_SDK>/examples/DevelopersGuide/ProfUNO/CppBinding We first check the example (under Linux) : {{Lin| <pre> cd <OpenOffice_SDK> ./setsdkenv_unix cd examples/DevelopersGuide/ProfUNO/CppBinding make make Office_connect.run </pre> }} which only writes out "Connected successfully to the office". Under Windows it would be : {{Win| <pre> cd <OpenOffice_SDK> setsdkenv_windows cd examples/DevelopersGuide/ProfUNO/CppBinding make make Office_connect.run </pre> }} We first start our discussion from this example. Later on, we will provide another starting code. All listings we will give below are to be added at this example. Where ? It's shown here : <syntaxhighlight lang="cpp"> // Listing 1 Our first Connection //C++ *** extract from office_connect.cxx int main( ) { // create the initial component context Reference< XComponentContext > rComponentContext = defaultBootstrap_InitialComponentContext(); // retrieve the servicemanager from the context Reference< XMultiComponentFactory > rServiceManager = rComponentContext->getServiceManager(); // instantiate a sample service with the servicemanager. Reference< XInterface > rInstance = rServiceManager->createInstanceWithContext( OUString::createFromAscii("com.sun.star.bridge.UnoUrlResolver" ), rComponentContext ); // Query for the XUnoUrlResolver interface Reference< XUnoUrlResolver > rResolver( rInstance, UNO_QUERY ); if( ! rResolver.is() ) { printf( "Error: Couldn't instantiate com.sun.star.bridge.UnoUrlResolver service\n" ); return 1; } try { // resolve the uno-url rInstance = rResolver->resolve( OUString::createFromAscii( "uno:socket,host=localhost,port=8100;urp;StarOffice.ServiceManager" ) ); if( ! rInstance.is() ) { printf( "StarOffice.ServiceManager is not exported from remote counterpart\n" ); return 1; } // query for the simpler XMultiServiceFactory interface, sufficient for scripting Reference< XMultiServiceFactory > rOfficeServiceManager (rInstance, UNO_QUERY); if( ! rInstance.is() ) { printf( "XMultiServiceFactory interface is not exported for StarOffice.ServiceManager\n" ); return 1; } printf( "Connected sucessfully to the office\n" ); // ***** add your code here ************** } catch( Exception &e ) { OString o = OUStringToOString( e.Message, RTL_TEXTENCODING_ASCII_US ); printf( "Error: %s\n", o.pData->buffer ); return 1; } return 0; } </syntaxhighlight> I cannot explain all the lines of this source file, but if you want to have an idea of what you have to learn when using UNO SDK, have a look at all the interfaces encountered in this snippet. They are : <idl>com.sun.star.uno.XComponentContext</idl>, <idl>com.sun.star.lang.XMultiComponentFactory</idl>, <idl>com.sun.star.uno.XInterface</idl> and <idl>com.sun.star.bridge.XUnoUrlResolver</idl>. I can just say : here is one way among others to get the ServiceManager. The way to obtain the ServiceManager is named bootstraping process in {{AOo}} : see the next section or [[UNO_registery_and_Bootstrapping#The_Bootstrap|the complete explanation]]. A second way is given in <OpenOffice_SDK>/examples/cpp/DocumentLoader's example. Before to go further I want to give explanations. The code above shows, even if you don't understend it, how we program with UNO and C++. You should write C++ code with many strange variables like : <syntaxhighlight lang="cpp"> Reference< XSomething > rSomething = aWayToObtainSomething(); </syntaxhighlight> In this code XSomething is an interface because its name has a 'X' as first character. In the above code you have two ways to obtain interfaces: <syntaxhighlight lang="cpp"> // obtain an interface first way : buildin function Reference< XComponentContext > rComponentContext = defaultBootstrap_InitialComponentContext(); </syntaxhighlight> and also <syntaxhighlight lang="cpp"> // obtain an interface second way : UNO_QUERY starting from a service Reference< XUnoUrlResolver > rResolver( rInstance, UNO_QUERY ); </syntaxhighlight> How do I know I start from a service ? If the first character of the name is not a 'X', it is a service and if you want to obtain it, you have to cast it with a <idl>com.sun.star.uno.XInterface</idl>. You can see it's the case for rResolver variable in the listing 1 (com.sun.star.bridge.UnoUrlResolver service). {{Note| The C++ language doesn't allow you to use services directly, but rather interfaces. Every service has to be casted in a variable of type <idl>com.sun.star.uno.XInterface</idl>. It's not the same with {{AOo}} Basic programming which in the contrary allow you to use directly services. }} That piece of code is in general called bootstrapping and will be examined in the next section. == Introduction to Bootstrapping == Bootstrap processes are more deeply discussed [[UNO_registery_and_Bootstrapping#The_Bootstrap|later]]. We give only an introduction here. To memorize this previous piece of code is not easy and probably useless. However, we give a drawing representation of this piece of code to show the main step of the bootstrap process. [[Image:ch4Fig1bootstrap.png|none|thumb|600px|Bootstrapping Diagram]] If you are interested, have a simultaneous look at the code and the drawing, to see the schematic conventions I have used to carry out the Figure above. For instance, both XInterface are connected because we use the same variable in fact. The gray filled rectangles are for parameters... and so on. We want now the desktop and load a {{AOo}} Calc component. The '''first step''' is to obtain desktop. You then add this code : <syntaxhighlight lang="cpp"> // Listing 2 Obtaining a desktop interface // C++ Reference< XInterface > xDesktop = rOfficeServiceManager->createInstance( OUString::createFromAscii( "com.sun.star.frame.Desktop" )); </syntaxhighlight> Your desktop object is in xDesktop variable. More on Desktop service [[Documentation/BASIC_Guide/StarDesktop|here]]. '''Second step''' : query for the XComponentLoader interface <syntaxhighlight lang="cpp"> // Listing 3 Query a XcomponentLoader Interface // C++ // query a XcomponentLoader Interface Reference< XComponentLoader > rComponentLoader (xDesktop, UNO_QUERY); if( rComponentLoader.is() ) { printf( "XComonentloader succesfully instanciated\n" ); } </syntaxhighlight> Before to see the problems with this code, we give again a schematic representation : [[Image:ch4fig2Componentloader.png|none|thumb|600px|Component Loader]] The code above gives error messages : <pre> error 'XcomponentLoader' undeclared (First use this function) .... </pre> It shows us there is a problem with XComponentLoader : this indicates we have probably to add a hpp header file in the program's include statements. The file's name is probably XComponentLoader.hpp but we have to find where it lies. One way is to go in the [https://www.openoffice.org/api/docs/common/ref/index-files/index-1.html general index] and to look for XComponentLoader. We find : <idl>com.sun.star.frame.XComponentLoader</idl> which indicates <syntaxhighlight lang="cpp"> #include <com/sun/star/frame/XComponentLoader.hpp> </syntaxhighlight> is required. We can try and see it is not enough, we obtain always the same error message and one new before : com/sun/star/frame/XComponentLoader.hpp: No such file or directory I have already discussed this fact : the SDK doesn't provide any hpp file, they have to be constructed from IDL files. An other task is then: open and change the makefile. Only add the correspondant line: <pre> #added com.sun.star.frame.XComponentLoader TYPES := \ com.sun.star.uno.XNamingService \ com.sun.star.uno.XComponentContext \ com.sun.star.uno.XWeak \ com.sun.star.uno.XAggregation \ com.sun.star.frame.XComponentLoader \ com.sun.star.lang.XMain \ com.sun.star.lang.XMultiServiceFactory \ com.sun.star.lang.XSingleComponentFactory \ com.sun.star.lang.XTypeProvider \ com.sun.star.lang.XComponent \ com.sun.star.registry.XSimpleRegistry \ com.sun.star.registry.XImplementationRegistration \ com.sun.star.bridge.XBridgeFactory \ com.sun.star.bridge.XUnoUrlResolver \ com.sun.star.container.XHierarchicalNameAccess </pre> Making the project gives again the same error message. What is still lacking now ? Only a namespace statement in the source file : <syntaxhighlight lang="cpp"> // C++ using namespace com::sun::star::frame; </syntaxhighlight> (To go further with the two steps above see [[IDL_Files_and_Cpp#Getting_an_interface_in_C.2B.2B|Getting an Interface in C++]]) '''Step 3''' : get an instance of the spreadsheet <syntaxhighlight lang="cpp"> // Listing 4 Loading a new OOoCalc document // C++ Reference< XComponent > xcomponent = rComponentLoader->loadComponentFromURL( OUString::createFromAscii("private:factory/scalc"), OUString::createFromAscii("_blank"), 0, Sequence < ::com::sun::star::beans::PropertyValue >()); </syntaxhighlight> and it works : you have a new {{AOo}} Calc document. This [[IDL_Files_and_Cpp#Getting_an_interface_in_C.2B.2B|hyperlink]] will tackle again the header file construction problem. An other thing to note is : when constructing variables with Reference template like : <pre> Reference<...>varName </pre> you can check with <pre> varName.is() </pre> function. The problem of what to do if this variable is not created (varName.is() is false) is complex and not deeply tackled in this document. It refers to exceptions. = The Compilation Chain = Perhaps we need to recall we use the phrase "compilation chain" to refer to a schematic representation of the makefile. This give information on what kind of files and tools are involved when constructing a UNO binary. Skills on the compilation chain are important only if you want to modify a makefile. At this point, it is important for you to have skills on necessary tools for [[Documentation/DevGuide/WritingUNO/Required_Files|UNO development]]. [[Image:CompilationChain2.png|center|UNO binary build chain]] Please have a look [[UNO_registery_and_Bootstrapping#office_connect.rdb_File_creation|here]] if you want to see how <code>regmerge</code> and <code>regcomp</code> are used for office_connect.rdb file creation. {{Note|'''Important Note''' : The more important point in this compilation chain is in fact that <code>cppumaker</code> will construct every hpp and hdl files you need in your application. The SDK is not provinding all hpp files but you have to construct them starting from IDL files provided by SDK.}} {{Note|It is possible to construct all the hpp files when installing the SDK as [[SDKInstallation#Other_Windows_Installations_descriptions|mentioned in a Windows]] installation. It's also possible with other OS. In doing so, you don't need modifying your MakeFile.}} You can find a compilation chain [[Constructing_Components#Make_dependency_of_a_Component|here in this Wiki]] and also [[Counter_Example|here]]. I will probably in the future tackle the makefile problem in a [[MakeFile|Make Chapter]]. We can also find a compilation chain figure in Java Eclipse Tutorial [[JavaEclipseTuto|here]] shown below : [[Image:CompilationChain.png|center|UNO component build chain]] {{Tip|We don't use the same Files and Tools schematic representation in our compilation chain diagrams. I find this one more compact than mine but at the moment I don't plan to change : perhaps in the future.}} = Preparing a new Code as a starting Point = The programming style presented in [[UNO_automation_with_a_binary_%28executable%29#Introduction_:_starting_from_a_SDK_example |introduction]] doesn't completely satisfy me. I give it because it's more easy to start explanations from an example provided with the SDK than to start with a new code. I find the functions with [[CppSDKAuthors|Niall Dorgan's]] code style better in [https://web.archive.org/web/20071123103036/http://www.oooforum.org/forum/viewtopic.phtml?t=8664 oooforum.org]. Then I will adopt it slightly modified : a function is responsible of the connection : ooConnect() {{:OOConnect}} This function can be used with : {{:MainOOConnect}} {{Note|Put the above code in office_connect.cxx file in the <OpenOffice_SDK>/examples/DevelopersGuide/ProfUNO/CppBinding directory (renaming and storing the old office_connect.cxx) and you can use the slightly modified makefile of previous [[UNO_automation_with_a_binary_%28executable%29#Introduction_:_starting_from_a_SDK_example |introduction]] to compile the project. From now on, we will use this code as starting point. It means I will give only part of this code in the examples : the main() or part of the main. If you want to understand the ooConnect() code, have a look at [[Documentation/BASIC_Guide/StarDesktop|The StarDestop]] describing the Desktop service.}} * an other way to bootstrap is [[Constructing_Helpers#The_GAP.27s_Helper|described here]] with a C++ class. = To find and to save the Document = Read [[Documentation/BASIC_Guide/StarDesktop|The StarDestop]] if you want to understand more on Desktop service. This whole section is based on the change of the below C++ Listing 6 in the previous Listing 5 : <syntaxhighlight lang="cpp"> //Listing 6 Creating a new Component //C++ //get an instance of the spreadsheet Reference< XComponent > xcomponent = rComponentLoader->loadComponentFromURL( OUString::createFromAscii("private:factory/scalc"), OUString::createFromAscii("_blank"), 0, Sequence < ::com::sun::star::beans::PropertyValue >()); </syntaxhighlight> The two parameters "private:factory/scalc" and “_blank” strings can be changed. Let's see what happens with these changes. Loading an existing File To load an existing file, change the previous code of Listing 6 as {{Lin| <syntaxhighlight lang="cpp"> //Listing 7 Loading a known File //C++ //get an instance of the spreadsheet Reference< XComponent > xcomponent = rComponentLoader->loadComponentFromURL( OUString::createFromAscii("file:///home/smoutou/work/undocument.sxc"), OUString::createFromAscii("_blank"), 0, Sequence < ::com::sun::star::beans::PropertyValue >()); </syntaxhighlight> }} You want to load, or to take an existing opened document with the same name, change the “_blank” parameter : {{Lin| <syntaxhighlight lang="cpp"> //Listing 8 Changing the _blank Parameter // C++ //get an instance of the spreadsheet Reference< XComponent > xcomponent = rComponentLoader->loadComponentFromURL( OUString::createFromAscii("file:///home/smoutou/OneDocument.sxc"), OUString::createFromAscii("_default"), 0, Sequence < ::com::sun::star::beans::PropertyValue >()); </syntaxhighlight> }} The presented file's name is a UNIX-like name. Under Windows we can use the equivalence {{Win| <pre> C:\My Documents\tata.sxc file:///C|/My%20Documents/tata.sxc </pre> }} On the left the system depending file's name, what is named the system path, and on the right the URL's file. It is possible to automatically construct the URL's file : {{Lin| <syntaxhighlight lang="cpp"> //Listing 9 Constructing an URL // LINUX C++ // Don't forget #include <osl/file.hxx> OUString sDocUrl; osl::FileBase::getFileURLFromSystemPath( OUString::createFromAscii("/home/smoutou/edt.sxd"),sDocUrl); //get an instance of the spreadsheet Reference< XComponent > xcomponent = rComponentLoader->loadComponentFromURL( sDocUrl, OUString::createFromAscii("_blank"), 0, Sequence < ::com::sun::star::beans::PropertyValue >()); </syntaxhighlight> }} and the corresponding Windows code : {{Win| <syntaxhighlight lang="cpp"> //Listing 9b Constructing an URL // Windows C++ to check // Don't forget #include <osl/file.hxx> OUString sDocUrl; osl::FileBase::getFileURLFromSystemPath( OUString::createFromAscii("C:\\My Documents\\tata.sxc"),sDocUrl); //get an instance of the spreadsheet Reference< XComponent > xcomponent = rComponentLoader->loadComponentFromURL( sDocUrl, OUString::createFromAscii("_blank"), 0, Sequence < ::com::sun::star::beans::PropertyValue >()); </syntaxhighlight> }} An other way is to construct the URL form a file name and a directory name <syntaxhighlight lang="cpp"> //Listing 10 Constructing an URL : an other Way // C++ LINUX and Windows // Don't forget #include <osl/file.hxx> // Don't forget #include <osl/process.hxx> OUString sDocUrl, sWorkingDir; osl_getProcessWorkingDir(&sWorkingDir.pData); osl::FileBase::getAbsoluteFileURL( sWorkingDir, OUString::createFromAscii("edt.sxd"), sDocUrl); //get an instance of the spreadsheet Reference< XComponent > xcomponent = rComponentLoader->loadComponentFromURL( sDocUrl, OUString::createFromAscii("_blank"), 0, Sequence < ::com::sun::star::beans::PropertyValue >()); </syntaxhighlight> where the file URL is constructed from the executing directory and the file name. Other transformations are possible : see osl::FileBase documentation in https://www.openoffice.org/api/docs/cpp/ref/names/osl/c-FileBase.html == Create a new Document == You choose your document type and then replace "private:factory/scalc" by the corresponding magical text : ; magical text {| border cellspacing="0" width="550" |- style = "background:#b3e2d1;text-align:center" | |new Document's Type||Magical Text |- style="text-align:center" | Writer text ||private:factory/swriter |- style="text-align:center" | Calc spreadsheet ||private:factory/scalc |- style="text-align:center" | Draw||private:factory/sdraw |- style="text-align:center" | Impress presentation ||private:factory/simpress |- style="text-align:center" | Math formula ||private:factory/smath |} ==The default opened Document== The way to obtain the default document is slightly different from the previous two chapters. We then first give the program lines to change and after the effective changes. To find the default document, change the previous code given again below in Listing 11 with those given in Listing 12. See also <idl>com.sun.star.uno.XInterface</idl>, <idl>com.sun.star.frame.XComponentLoader</idl> and <idl>com.sun.star.lang.XComponent</idl> interfaces. <syntaxhighlight lang="cpp"> //Listing 11 Finding the default Document : code to remove //C++ //get the desktop service using createInstance returns an XInterface type Reference< XInterface > Desktop = rOfficeServiceManager->createInstance( OUString::createFromAscii( "com.sun.star.frame.Desktop" )); //query for the XComponentLoader interface Reference< XComponentLoader > rComponentLoader (Desktop, UNO_QUERY); if( rComponentLoader.is() ){ printf( "XComponentloader successfully instanciated\n" ); } //get an instance of the spreadsheet Reference< XComponent > xcomponent = rComponentLoader->loadComponentFromURL( OUString::createFromAscii("private:factory/scalc"), OUString::createFromAscii("_blank"), 0, Sequence < ::com::sun::star::beans::PropertyValue >()); // add code here return 0; </syntaxhighlight> here is our new code : <syntaxhighlight lang="cpp"> //Listing 12 Finding the default Document : Code to insert // C++ // Don't forget the #include <com/sun/star/frame/XDesktop.hpp> // Don't forget to add com.sun.star.frame.XDesktop \ in the makefile //get the desktop service using createInstance returns an XInterface type Reference< XInterface > Desktop = rOfficeServiceManager->createInstance( OUString::createFromAscii( "com.sun.star.frame.Desktop" )); //query the XDesktop Interface Reference< XDesktop > xDesktop (Desktop, UNO_QUERY); Reference< XComponent > xcomponent = xDesktop->getCurrentComponent(); return 0; </syntaxhighlight> As you can see we have to query the XDesktop interface. It is important to note that every time you will query for an interface, you have to add one or two lines in the listing and an other in the makefile. To go further with explanations have a look [[IDL_Files_and_Cpp#IDL__and_C.2B.2B|here]] if you are not a beginner ==Save the Document== In the examples of this section you will query for an interface : the <idl>com.sun.star.frame.XStorable</idl> interface. Now you can save with adding the code <syntaxhighlight lang="cpp"> //Listing 13 How to store a Document // C++ // Don't forget the #include <com/sun/star/frame/XStorable.hpp> // Don't forget to add com.sun.star.frame.XStorable \ in the makefile // Query for Xstorable interface Reference< XStorable > rcomponentStore (xcomponent, UNO_QUERY); if( !rcomponentStore.is() ){ printf( "XStorable Not successfully instanciated\n" ); }else rcomponentStore->store(); </syntaxhighlight> It is also possible to give a name when saving : {{Win| <syntaxhighlight lang="cpp"> //Listing 14 How to store a Document (Windows version) // C++ Windows to check //document save as // Don't forget the #include <com/sun/star/frame/XStorable.hpp> // Don't forget to add com.sun.star.frame.XStorable \ in the makefile // query for the ::com::sun::star::frame::XStorable interface Reference< XStorable > rcomponentStore (xcomponent, UNO_QUERY); if( !rcomponentStore.is() ){ printf( "XStorable Not successfully instanciated\n" ); }else rcomponentStore->storeAsURL(OUString::createFromAscii( "file:///C|/My%20Documents/tata.sxd"), Sequence < ::com::sun::star::beans::PropertyValue >()); </syntaxhighlight> }} or {{Lin| <syntaxhighlight lang="cpp"> //Listing 15 How to store a Document (Linux Version) // C++ LINUX //document save as // Don't forget the #include <com/sun/star/frame/XStorable.hpp> // Don't forget to add "com.sun.star.frame.XStorable \" in the makefile // query for the ::com::sun::star::frame::XStorable interface Reference< XStorable > rcomponentStore (xcomponent, UNO_QUERY); if( !rcomponentStore.is() ){ printf( "XStorable Not successfully instanciated\n" ); }else rcomponentStore->storeAsURL(OUString::createFromAscii("file:///home/smoutou/tata.sxd"), Sequence < ::com::sun::star::beans::PropertyValue >()); </syntaxhighlight> }} We are now ready to describe all the different {{AOo}} applications. We will begin with {{AOo}} Calc but before starting we have a look at Desktop. =My first Container enumeration with Desktop= The container is an important {{AOo}} programming concept because you find it everywhere. In a worksheet all the sheets are in a container, in a Draw document, all the slides are in a container, in a slide all the shapes are in a container and so on. ==XEnumerationAccess Interface== Using <idl>com.sun.star.frame.XDesktop</idl>, <idl>com.sun.star.container.XEnumerationAccess</idl>, <idl>com.sun.star.lang.XServiceInfo</idl> and <idl>com.sun.star.frame.XStorable </idl> interfaces follow us in this example of code : <syntaxhighlight lang="cpp"> //Listing 16 XEnumeration Interface // C++ // container // Don't forget to add : using namespace com::sun::star::frame; // Don't forget to add : #include <com/sun/star/frame/XDesktop.hpp> // Don't forget to add "com.sun.star.frame.XDesktop \" in the makefile Reference<XDesktop> desk(xServiceManager->createInstance( OUString::createFromAscii("com.sun.star.frame.Desktop")), UNO_QUERY); // Don't forget to add : using namespace com::sun::star::container; // Don't forget to add : #include <com/sun/star/container/XEnumerationAccess.hpp> // Don't forget to add "com.sun.star.container.XEnumerationAccess \" in the makefile Reference<XEnumerationAccess> comps = desk->getComponents(); if (comps->hasElements()) { Reference<XEnumeration> compenum(comps->createEnumeration(), UNO_QUERY); while (compenum->hasMoreElements()) { Reference<XComponent> comp(compenum->nextElement(), UNO_QUERY); // Don't forget to add : using namespace com::sun::star::lang; // Don't forget to add : #include <com/sun/star/lang/XServiceInfo.hpp> // Don't forget to add "com.sun.star.lang.XServiceInfo \" in the makefile Reference<XServiceInfo> serviceinfo(comp, UNO_QUERY); if (serviceinfo->supportsService( OUString::createFromAscii("com.sun.star.document.OfficeDocument"))) { // Don't forget to add : #include <com/sun/star/frame/XStorable.hpp> // Don't forget to add "com.sun.star.frame.XStorable \" in the makefile Reference<XStorable> storeable(comp, UNO_QUERY); if (storeable->hasLocation()) { OString loc = OUStringToOString(storeable->getLocation(), RTL_TEXTENCODING_ASCII_US); printf("-- %s\n",loc.pData->buffer); } } } } </syntaxhighlight> This program prints out : {{Lin| <pre> -- file:///home/smoutou/OpenOffice_SDK/UNOCpp_AP01.sxw -- file:///home/smoutou/Inetrecup/Openoffice/01prog_menu-context_officebean2.sxw </pre> }} depending what files are loaded in {{AOo}} and what OS you do use. In general, there are two ways to access a container : with an index or with a name. The corresponding interfaces are XIndexAccess and XNameAccess. If you want to know what you can do with an Interface, have a look in the corresponding IDL file. IDL files are explained later in the document ([[IDL_Files_and_Cpp|see chapter 10]]). For instance we give here the <idl>com.sun.star.container.XIndexAcess</idl> IDL file (removing all the comments) : <syntaxhighlight lang="cpp"> //Listing 17 XIndexAccess IDL File (without Comments) // IDL module com { module sun { module star { module container { interface XIndexAccess: com::sun::star::container::XElementAccess { long getCount(); any getByIndex( [in] long Index ) raises( com::sun::star::lang::IndexOutOfBoundsException, com::sun::star::lang::WrappedTargetException ); }; }; }; }; }; </syntaxhighlight> The IDL path can be retrieved with this file's content :<OpenOffice_SDK>/idl/com/sun/star/container and the file's name is only the interface's name followed by “.idl”. Two methods can be used : <tt>getCount()</tt> and <tt>getByIndex()</tt> as it is easy to see in the above listing. See also <idl>com.sun.star.container.XElementAccess</idl>. == XNameAccess Interface == The second access interface is described with <idl>com.sun.star.container.XNameAccess</idl> : <syntaxhighlight lang="cpp"> //Listing 18 XNameAccess IDL file (without Comments) // IDL module com { module sun { module star { module container { interface XNameAccess: com::sun::star::container::XElementAccess { any getByName( [in] string aName ) raises( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException ); sequence<string> getElementNames(); boolean hasByName( [in] string aName ); }; }; }; }; }; </syntaxhighlight> and then three methods. Our goal is to see the desktop as a container. It can effectively contains windows. See also <idl>com.sun.star.container.XElementAccess</idl>. ==What is not clear for me (and then need Help)== {{HelpNeeded|EN|Please add text on difference between services and interfaces}} Later on, I will describe a [[Constructing_Helpers#Reflection_Helper|reflection helper]]. It allows us to know methods and properties of an object... When I use this helper to see methods of “Desktop” object I clearly see getComponents() method. But I cannot call it. I have to construct a desktop variable named “desk” in the listing above before to call it. The desktop variable is a service while desk is an interface. In C++ you have to use interface while in {{AOo}} Basic you use service. We don't need an “#include <com/sun/star/lang/XComponent.hpp>” and I don't see why ! You can find any explanations [[IDL_Files_and_Cpp#IDL__and_C.2B.2B|here]] written after the lines above (if you are not a beginner). =Chapter Summary= I am always more interested in diagram than in long explanation : probably because of my little knowledge in English. Schematic drawings are easy to grasp only if we know every conventions. If not the case please read again the beginning of this chapter (particularly [[UNO_automation_with_a_binary_%28executable%29#Introduction_:_starting_from_a_SDK_example |introduction]]). We now give, in a schematic form, all what we have learnt in this chapter. [[Image:ch4fig3Summary.png]] {{Note|'''Note''' : The arrows in this drawing are what I call in a forthcoming chapter, finding a path in an IDL-Tree. The lecture of the corresponding [[Programming_OooWriter#Going_further_with_Inspector|section]] would be useful, even if at the moment, you are unable to understand completely the problem. Viewing the problem from different angles is always a good exercise.}} {{Template:Home_Page}} = See also = * [[FR/Documentation/L%27automation_d%27OpenOffice.org_avec_un_binaire_ex%C3%A9cutable|French version of this chapter]]. * [[Documentation/BASIC_Guide/API_Intro|Introduction to the {{AOo}} API]] * [[Documentation/BASIC_Guide/StarDesktop|The StarDestop]] * [[Uno/Cpp/Tutorials/Introduction_to_Cpp_Uno|C++ and UNO tutorial]] * To learn C++ : [http://www.smart2help.com/e-books/ C++ e-books] * All my UNO/C++ document is available [http://perso.wanadoo.fr/moutou/MyUNODoc_HTML/UNOCppAPI.html here] * Writing a Program to Control OpenOffice.org, by Franco Pingiori — [http://www.linuxjournal.com/article/8550 Part 1] and [http://www.linuxjournal.com/article/8608 Part 2], Linux Journal [[Category:Uno]] [[Category:Cpp]] [[Category:Tutorial]] [[Category:Samples]]

Return to UNO automation with a binary (executable).