offapi/com/sun/star/modules.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 /* note: this file contains documentation of the modules.
  21          sub-modules of modules are documented here too so there aren't
  22          lots of tiny documentation only files everywhere.
  23 */
  24
  25 module com { module sun { module star {
  26
  27 /** UNO Accessibility API
  28
  29     <p>This modules contains the basic interfaces of the UAA (UNO
  30     Accessibility API).  Services that describe how these interfaces are
  31     implemented can be found in other modules.  The services in this module
  32     describe only what every accessible object has to support.</p>
  33
  34     <p>Making a class accessible starts by supporting the
  35     ::com::sun::star::accessibility::XAccessible interface.
  36     This interface's only method returns the actual accessibility object, an
  37     instance of ::com::sun::star::accessibility::XAccessibleContext.
  38     These two interfaces may be implemented by the same class in which case
  39     a call to ::com::sun::star::accessibility::XAccessible getAccessible()
  40     returns the same object that is
  41     called.  Alternatively the implementation of the
  42     ::com::sun::star::accessibility::XAccessibleContext
  43     interface can be done by another class.  This makes it possible to put
  44     all accessibility implementations into their own library which has only
  45     to be loaded when necessary.</p>
  46
  47     <p>Note that all other interfaces have to be implemented by the same
  48     class that implements the
  49     ::com::sun::star::accessibility::XAccessibleContext
  50     interface.  Note also that there is no way back from an accessibility
  51     object to the object from which it has been obtained by means of the
  52     UAA.  If you need such a back-link you have to provide one on your
  53     own.</p>
  54 */
  55 module accessibility {};
  56
  57 /// interfaces for SMIL animations.
  58 module animations {};
  59
  60 /// security and authenticates interfaces
  61 module auth {};
  62
  63 /// Java AWT-like user interface toolkit interface specifications for UNO.
  64 module awt {
  65
  66     /// grid control.
  67     module grid {};
  68
  69     /// tab pages.
  70     module tab {};
  71
  72     /// hierarchical (tree) control.
  73     module tree {};
  74
  75 };
  76
  77 /// Charting diagram interfaces.
  78 module chart {};
  79
  80 /** New implementation of Charting diagram interfaces.  This module
  81     contains only a rather small public API.  In addition there is a
  82     private API in the chart2 project.
  83  */
  84 module chart2 {
  85
  86     /// Chart data provider interfaces.
  87     module data {};
  88 };
  89
  90 /// Access to the tree of configuration data.
  91 module configuration {
  92
  93     /// interfaces for configuration backends.
  94     module backend {
  95         /// XML files backend.
  96         module xml {};
  97     };
  98
  99     /// deprecated bootstrapping mechanism.
 100     module bootstrap {};
 101
 102 };
 103
 104 /// Common user interface elements
 105 module cui {};
 106
 107 /// Clipboard and Drag&amp;Drop interfaces.
 108 module datatransfer {
 109
 110     /// Clipboard specific interfaces.
 111     module clipboard {};
 112
 113     /// Drag&amp;Drop specific interfaces.
 114     module dnd {};
 115
 116 };
 117
 118 /// interfaces for extension management.
 119 module deployment {
 120
 121     // this looks like it should not be documented
 122     module test {};
 123
 124     /// interfaces for extension management dialogs.
 125     module ui {};
 126
 127 };
 128
 129 /// Office document related interfaces.
 130 module document {};
 131
 132 /// Drawing and shape specific interfaces.
 133 module drawing {
 134
 135     /// Draw/Impress user interface framework.
 136     module framework {};
 137
 138 };
 139
 140 /// interfaces related to embedded objects, both native UNO and OLE.
 141 module embed {};
 142
 143 /// Interfaces for managing forms and controls.
 144 module form {
 145
 146     /// form bindings.
 147     module binding {};
 148
 149     /// form components (model part of the controls).
 150     module component {};
 151
 152     /// form components (view part of the controls).
 153     module control {};
 154
 155     /// various property handlers for forms.
 156     module inspection {};
 157
 158     /// core components of forms.
 159     module runtime {};
 160
 161     /// for submission of data from forms.
 162     module submission {};
 163
 164     /// for validation of form data.
 165     module validation {};
 166
 167 };
 168
 169 /// Interfaces for mathematical formulas.
 170 module formula {};
 171
 172 /// Desktop environment framework interfaces.
 173 module frame {
 174
 175     /// various status properties.
 176     module status {};
 177
 178 };
 179
 180 /// interfaces for galleries of images and media objects.
 181 module gallery {};
 182
 183 /// Interfaces and data types to deal with basic geometric entities
 184 module geometry {};
 185
 186 /// Interfaces for graphic handling
 187 module graphic {};
 188
 189 /** Interface for internationalization. Regard this as an internal API,
 190     subject to change. */
 191 module i18n {};
 192
 193 /// interfaces for HTML image maps.
 194 module image {};
 195
 196 /// interfaces for inspecting UNO objects via property handlers.
 197 module inspection {};
 198
 199 /// lightweight directory access protocol (LDAP)
 200 module ldap {};
 201
 202 /// Spell checker, hyphenation and thesaurus interfaces.
 203 module linguistic2 {};
 204
 205 /// logging of events.
 206 module logging {};
 207
 208 /// Interfaces for Email connectivity
 209 module mail {};
 210
 211 /// Media type interfaces
 212 module media {};
 213
 214 /// Interfaces for Mozilla integration.
 215 module mozilla {};
 216
 217 /// Office document content related interfaces.
 218 module office {};
 219
 220 /// Package file format interfaces.
 221 module packages {
 222
 223     /// interfaces for reading and writing manifest.xml files in ODF packages.
 224     module manifest {};
 225
 226     /// for direct access to ZIP packages.
 227     module zip {};
 228
 229 };
 230
 231 /// Netscape-like plugin interfaces.
 232 module plugin {};
 233
 234 /// Presentation specific interfaces.
 235 module presentation {
 236
 237     /// for text fields in presentation documents.
 238     module textfield {};
 239
 240 };
 241
 242 /// Interfaces for QA and automated tests
 243 module qa {};
 244
 245 /** RDF (Resource Description Framework) and metadata interfaces.
 246
 247     <p>
 248     This module provides interfaces for storing and accessing metadata
 249     in <a href="http://www.w3.org/RDF/">Resource Description Framework</a>
 250     format.
 251     The API consists of two main parts: the RDF data model and the ODF
 252     document integration.
 253     </p>
 254
 255     <p>
 256     The <a href="http://www.w3.org/TR/rdf-concepts/">RDF data model</a>
 257     describes graphs of statements.
 258     The nodes in the graph are of type rdf::XNode,
 259     which has several subtypes: rdf::XResource,
 260     rdf::XBlankNode,
 261     rdf::XURI and rdf::XLiteral.
 262     Statements are then triples of nodes, and have type
 263     rdf::Statement.
 264     </p>
 265
 266     <p>
 267     The main part of the RDF data model is the
 268     rdf::XRepository, which consists of a set of graphs.
 269     The repository allows for importing/exporting graphs from/to files,
 270     as well as querying the contents of the repository.
 271     The type of the graphs is rdf::XNamedGraph.
 272     </p>
 273
 274     <p>
 275     Documents that support metadata implement the interfaces
 276     rdf::XRepositorySupplier and
 277     rdf::XDocumentMetadataAccess.
 278     Furthermore, all elements of ODF documents that may have metadata attached
 279     implement the interface rdf::XMetadatable.
 280     </p>
 281
 282  */
 283 module rdf {};
 284
 285 /// Interfaces and data structures for rendering
 286 module rendering {};
 287
 288 /// interfaces for reports generated from data sources.
 289 module report {
 290
 291     /// property handlers for reports.
 292     module inspection {};
 293
 294     /// report meta data.
 295     module meta {};
 296
 297 };
 298
 299 /// Interfaces to access (UI) resource files.
 300 module resource {};
 301
 302 /// Interfaces for scanner control.
 303 module scanner {};
 304
 305 /// Scripting language bindings.
 306 module script {
 307
 308     /// manage available scripts in some sort of hierarchy.
 309     module browse {};
 310
 311     /// interfaces for scripting providers.
 312     module provider {};
 313
 314     /// VBA scripting.
 315     module vba {};
 316
 317 };
 318
 319 /// Basic interfaces for database access.
 320 module sdb {
 321
 322     /// application UI.
 323     module application {};
 324
 325     /// misc stuff.
 326     module tools {};
 327
 328 };
 329
 330 /// Database component interfaces.
 331 module sdbc {};
 332
 333 /// High-level database component interfaces.
 334 module sdbcx {};
 335
 336 /// cryptographic interfaces.
 337 module security {};
 338
 339 /// Setup specific interfaces
 340 module setup {};
 341
 342 /// Spreadsheet specific interfaces.
 343 module sheet {};
 344
 345 /// allows to put smart tags in document content.
 346 module smarttags {};
 347
 348 /// Formatting and layout style and style sheet interfaces.
 349 module style {};
 350
 351 /// Interfaces for import/export of Scalable Vector Format.
 352 module svg {};
 353
 354 /// Host operating system integration interfaces.
 355 module system {};
 356
 357 /// Table specific interfaces (for text and spreadsheet).
 358 module table {};
 359
 360 /// Task management interfaces.
 361 module task {};
 362
 363 /// Text specific interfaces.
 364 module text {
 365
 366     /// text field masters.
 367     module fieldmaster {};
 368
 369     /// text fields.
 370     module textfield {
 371
 372         /// Document Properties text fields.
 373         module docinfo {};
 374
 375     };
 376
 377 };
 378
 379 /// Universal Content Broker interfaces.
 380 module ucb {};
 381
 382 /// Dialogs and other UI elements.
 383 module ui {
 384
 385     /// dialogs.
 386     module dialogs {};
 387
 388 };
 389
 390 /// Miscellaneous interfaces for sorting, connecting objects etc.
 391 module util {};
 392
 393 /// Document view specific interfaces (e.g. selection access and printing).
 394 module view {};
 395
 396 /// interfaces for XForms (XML-based forms) implementation
 397 module xforms {};
 398
 399 /// XML related interfaces.
 400 module xml {
 401
 402     /// XML encryption interfaces.
 403     module crypto {
 404
 405         /// XML encryption SAX interfaces.
 406         module sax {};
 407
 408     };
 409
 410     /// Compressed SAX interfaces.
 411     module csax {};
 412
 413     /// XML Document Object Model.
 414     module dom {
 415
 416         /// XML Document Object Model events.
 417         module events {};
 418
 419         /// XML Document Object Model views.
 420         module views {};
 421
 422     };
 423
 424     /// no idea what this does but it's all marked "internal".
 425     module input {};
 426
 427     /// SAX interfaces.
 428     module sax {};
 429
 430     /// something related to creating DOMs from SAX interfaces?
 431     module wrapper {};
 432
 433     /// XPath interfaces.
 434     module xpath {};
 435
 436     /// XSLT interfaces.
 437     module xslt {};
 438
 439 };
 440
 441 /// W3C XML Schema-2 data type related interfaces.
 442 module xsd {};
 443
 444 }; }; };
 445
 446 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */