From 0b7cde3aabef66890ebeb3ab8581d2104473214a Mon Sep 17 00:00:00 2001 From: Rafael Lima Date: Mon, 2 Aug 2021 16:53:20 +0200 Subject: Create help page for the Development Tools feature Change-Id: Ib392399fa71c27ce6be7fca8c55985d75519ea87 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/119855 Tested-by: Jenkins Reviewed-by: Olivier Hallot --- source/text/shared/guide/dev_tools.xhp | 152 +++++++++++++++++++++++++++++++++ 1 file changed, 152 insertions(+) create mode 100644 source/text/shared/guide/dev_tools.xhp (limited to 'source/text/shared/guide/dev_tools.xhp') diff --git a/source/text/shared/guide/dev_tools.xhp b/source/text/shared/guide/dev_tools.xhp new file mode 100644 index 0000000000..80df75efa5 --- /dev/null +++ b/source/text/shared/guide/dev_tools.xhp @@ -0,0 +1,152 @@ + + + + + + + Development Tools + /text/shared/guide/dev_tools.xhp + + + + + development tools + object inspector + + + +

Development Tools

+ Inspects objects in %PRODUCTNAME documents and shows supported UNO services, as well as available methods, properties and implemented interfaces. This feature also allows to explore the document structure using the Document Object Model (DOM). +

+ Choose Tools - Development Tools +

+ After Development Tools is enabled it will become visible in all documents and %PRODUCTNAME applications. This setting is persistent and the Development Tools will remain visible until it is explicitly disabled by choosing Tools - Development Tools. + When Development Tools is enabled, a dockable window will be shown at the bottom of the screen. This window has two main sections: + + + Document Object Model tree view: Displays document portions according to the Document Object Model (DOM). Use this section to chose the object to inspect. + + + Object inspection panel: Displays the available services, methods, properties and interfaces of the selected object. + + + This feature is available since %PRODUCTNAME 7.2 and can be used in Writer, Calc, Impress and Draw. +

Document Model Tree View

+ The left side of the window contains a Current Selection toggle button, a Refresh button and a tree view that displays all objects in the document. + The behavior of the tree view depends on the status of the Current Selection toggle button: + + + If Current Selection is enabled, then the Object Inspection Panel will display the properties of the object that is currently selected in the document. Hence, clicking any item in the tree view will have no effect. + + + If Current Selection is disabled, then clicking any item in the tree view will update the contents of the Object Inspection Panel. + + + The types of objects displayed by the Document Model Tree View depend on the %PRODUCTNAME application being used: + + + + %PRODUCTNAME application + + + Supported objects + + + + + Writer + + + Paragraphs
Text Portions in a Paragraph
Shapes
Tables
Frames
Graphic Objects
Embedded Objects (OLE)
Style Families and Styles + + + + + Calc + + + Sheets
Shapes per sheet
Charts per sheet
Pivot tables per sheet
Style Families and Styles + + + + + Impress + + + Slides
Shapes per slide
Master slides
Style Families and Styles + + + + + Draw + + + Pages
Shapes per page
Style Families and Styles + + +

Object Inspection Panel

+ The right side of the window consists of the Object Inspection Panel that displays information about the object being inspected. + The first piece of information available is the Class Name, which is the name of the implementation class of the object. + Use the class name to search more information in the API documentation. For example, the top-level object in a Writer document is an instance of the class SwXTextDocument, which is documented at SwXTextDocument Class Reference. + It is possible to inspect the object further by using the four tabs available that display its Interfaces, Services, Properties and Methods. + Each of the tabs organize the information about the object in columns. The set of columns presented depend on which tab is selected. +

Interfaces tab

+ Contains a single column presenting the list of interfaces implemented by the object. +

Services tab

+ Contains a single column presenting the list of services supported by the object. +

Properties tab

+ Contains four columns that describe the properties of the object: + + + Property: Shows the names of all properties that can be inspected. + + + Value: Displays a textual representation of the values of all properties. + + + Type: Shows the property type. + + + Info: Presents relevant information about the property. For instance, a property that is read-only will have a "read-only" value in this column. + + + The Properties tab contains an additional section that shows a textual representation of the value of the selected property. When a property is selected the value is updated in the text box available at the bottom of the Object Inspection Panel. This is useful when the value is too long to be shown in the Value column. +

Methods tab

+ Contains four columns that describe the combined list of methods that can be called by the current object: + + + Method: Shows the names of all properties that can be inspected. + + + Return type: Displays the return type of the methods that can be called by the object. Methods that do not return any value are marked as "void" in this column. + + + Parameters: Shows the list of parameters that are required by the method as well as their respective types. + + + Implementation class: Displays the name of the class where the method is implemented. + + + +

+ + -- cgit