Appendix A: Apache OpenOffice API-Design-Guidelines

OpenOffice.org Developer's Guide

OpenOffice.org API-Design-Guidelines

< {{#switch:Previous Section

Previous Section = Previous Section

Next Section = Next Section

Previous Page = Previous Page

Next Page = Next Page

}}

{{#switch:Next Section

Previous Section = Previous Section

Next Section = Next Section

Previous Page = Previous Page

Next Page = Next Page

}} >

• General Design Rules
• Definition of API Elements

• Attributes
• Methods
• Interfaces
• Properties
• Events
• Services
• Exceptions
• Enums
• Typedefs
• Structs
• Parameter

• Special Cases
• Abbreviations
• Source Files and Types

< {{#switch:Previous Page

Previous Section = Previous Section

Next Section = Next Section

Previous Page = Previous Page

Next Page = Next Page

}}

{{#switch:Next Page

Previous Section = Previous Section

Next Section = Next Section

Previous Page = Previous Page

Next Page = Next Page

}} >

Download as a PDF or ODT

The following rules apply to all external programming interface specifications for OpenOffice. The API consists of the following stereotypes or design elements:

Structures

Structures are used to specify simple composed data elements.(Structures only consist of data, not methods.)

Exceptions

Exceptions are used for error handling.(Exceptions can be thrown or transported using an any.)

Interfaces

Interfaces are used to specify a single aspect in behavior.(Interfaces only consist of methods, not data.)

Services

Services are used to specify abstract objects.(Services specify properties and the interaction of the supported interfaces.)

Typedefs

Typedefs are used to define basic types for specific purposes.(This stereotype should be used carefully.)

Content on this page is licensed under the Public Documentation License (PDL).