org.docgene.model

Class XMLQtAPI

java.lang.Object

org.docgene.model.AbstractLink

org.docgene.model.AbstractAPI

org.docgene.model.XMLQtAPI

All Implemented Interfaces:

ElementReference, ExternalLink, ParagraphElement, StyledElement

public class XMLQtAPI
extends AbstractAPI

Represent an link to a Qt API.

Field Summary

Fields

Modifier and Type	Field and Description
static short	API_CLASS A link to a class.
static short	API_ENUM A link to an enum.
static short	API_METHOD A link to a method.
static short	API_PROPERTY A link to a property.

Fields inherited from class org.docgene.model.AbstractAPI

altPath, altText, api, isResolved, location, member, path, text, url

Fields inherited from class org.docgene.model.AbstractLink

isAbsolute, isValid

Fields inherited from interface org.docgene.model.StyledElement

TYPE_NONE

Constructor Summary

Constructors

Constructor and Description
XMLQtAPI() Create a Qt API link to the default Qt-5 API.
XMLQtAPI(java.lang.String api) Create a Qt API link.
XMLQtAPI(java.net.URL location) Create a Qt API link.

Method Summary

Modifier and Type	Method and Description
short	getAPIType() Return the API type.
java.lang.String	getDeclaration() Return the declaration ID of the element.
void	setAPIType(short type) Set the API type.

Methods inherited from class org.docgene.model.AbstractAPI

bind, bind, getAltPath, getAltText, getAPI, getAPILocation, getMember, getMemberPath, getPath, getShownPath, getText, getURL, hasAPI, hasAPILocation, isConstructor, isResolved, setAltPath, setConstructor, setMember, setMember, setPath

Methods inherited from class org.docgene.model.AbstractLink

getCustomStyles, getLineNumber, isAbsolute, isValid, setCustomStyles, setLineNumber, setValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.docgene.model.ExternalLink

getNotNullURL, getURLAsString, getURLAsString, getURLAsString

Methods inherited from interface org.docgene.model.StyledElement

getInlinedStyle, getStyle, hasInlinedStyle, setCustomStyles, setInlinedStyle

Methods inherited from interface org.docgene.model.ElementReference

hasLineNumber

Field Detail

API_CLASS

public static final short API_CLASS

A link to a class.

See Also:

Constant Field Values

API_METHOD

public static final short API_METHOD

A link to a method.

See Also:

Constant Field Values

API_PROPERTY

public static final short API_PROPERTY

A link to a property.

See Also:

Constant Field Values

API_ENUM

public static final short API_ENUM

A link to an enum.

See Also:

Constant Field Values

Constructor Detail

XMLQtAPI

public XMLQtAPI()

Create a Qt API link to the default Qt-5 API.

See Also:

APIsSpecs.QT5

XMLQtAPI

public XMLQtAPI(java.lang.String api)

Create a Qt API link.

Parameters:

api - the Qt API

See Also:

APILocations.getQtAPIs()

XMLQtAPI

public XMLQtAPI(java.net.URL location)

Create a Qt API link.

Parameters:

location - the location

Method Detail

getDeclaration

public java.lang.String getDeclaration()

Return the declaration ID of the element.

Returns:

the declaration ID of the element

setAPIType

public void setAPIType(short type)

Set the API type.

Parameters:

type - the API type

getAPIType

public short getAPIType()

Return the API type.

Returns:

the API type