Foundry.DocumentationIntent¶

Subclasses:: None

Methods¶

Inherited:: Foundry.Intent (9), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (documentation)
	`dup_documentation` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`documentation`	`Foundry.Documentation`	r/w/co

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Foundry.DocumentationIntent(**kwargs)¶

Bases:: Foundry.Intent
Abstract:: No
Structure:: Foundry.DocumentationIntentClass

Represents an intent to display documentation.

Foundry.DocumentationIntent provides functionality for displaying a [class`Foundry`.Documentation] object. It integrates with the intent system to provide a unified interface for documentation display operations across different parts of the development environment.

New in version 1.1.

classmethod new(documentation)¶

Parameters:: documentation (Foundry.Documentation) – a [class`Foundry`.Documentation]
Returns:: a new [class`Foundry`.DocumentationIntent]
Return type:: Foundry.Intent

Creates a new [class`Foundry`.DocumentationIntent] for displaying the given documentation.

New in version 1.1.

dup_documentation()¶

Returns:: a [class`Foundry`.Documentation]
Return type:: Foundry.Documentation

Gets a copy of the documentation object.

New in version 1.1.

Property Details¶

Foundry.DocumentationIntent.props.documentation¶

Name:: documentation
Type:: Foundry.Documentation
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY