Archicad 29 C++ API
Loading...
Searching...
No Matches
ACAPI::ModelViews::View Class Reference

A class that represents an Archicad navigator view. More...

#include <View.hpp>

Inheritance diagram for ACAPI::ModelViews::View:
ACAPI::Object

Public Member Functions

const API_GuidGetGuid () const
 Retrieves the guid of the view.
 
- Public Member Functions inherited from ACAPI::Object
 Object (std::shared_ptr< Impl::ObjectImpl > impl)
 Constructs a new object.
 
const API_TokenGetToken () const
 Get the token for this object.
 

Friends

Result< ViewFindViewByGuid (const API_Guid &guid)
 Constuct a view object referring to an existing Archicad view by guid.
 

Additional Inherited Members

- Protected Member Functions inherited from ACAPI::Object
 ~Object ()
 Default destructor.
 
- Protected Attributes inherited from ACAPI::Object
std::shared_ptr< Impl::ObjectImplmImpl
 Impl object given by constructor.
 

Detailed Description

A class that represents an Archicad navigator view.

Member Function Documentation

◆ GetGuid()

const API_Guid & ACAPI::ModelViews::View::GetGuid ( ) const

Retrieves the guid of the view.

Returns
The guid of the view.

Friends And Related Symbol Documentation

◆ FindViewByGuid

Result< View > FindViewByGuid ( const API_Guid & guid)
friend

Constuct a view object referring to an existing Archicad view by guid.

Parameters
guidThe guid of the view.
Returns
Returns the view wrapped in a Result.

It is compatible with the guid member of the API_NavigatorItem struct.