Kanzi Framework  3.9.0
Kanzi Engine API
page_host_properties.h File Reference

Functions

string getDefaultSubPage () const
 Gets the value of DefaultSubPageProperty. More...
 
ResourceSharedPtr getTransitions () const
 Gets the value of TransitionsProperty. More...
 
bool isLoopSubPages () const
 Gets the value of LoopSubPagesProperty. More...
 
void setDefaultSubPage (string value)
 Sets the value of DefaultSubPageProperty. More...
 
void setLoopSubPages (bool value)
 Sets the value of LoopSubPagesProperty. More...
 
void setTransitions (ResourceSharedPtr value)
 Sets the value of TransitionsProperty. More...
 

Variables

static PropertyType< string > DefaultSubPageProperty
 DefaultSubPage property. More...
 
static PropertyType< bool > LoopSubPagesProperty
 LoopSubPages property. More...
 
static PropertyType< ResourceSharedPtr > TransitionsProperty
 Transitions property. More...
 

Function Documentation

◆ getTransitions()

ResourceSharedPtr getTransitions ( ) const

Gets the value of TransitionsProperty.

See also
setTransitions()

◆ setTransitions()

void setTransitions ( ResourceSharedPtr  value)

Sets the value of TransitionsProperty.

See also
getTransitions()

◆ getDefaultSubPage()

string getDefaultSubPage ( ) const

Gets the value of DefaultSubPageProperty.

See also
setDefaultSubPage()

◆ setDefaultSubPage()

void setDefaultSubPage ( string  value)

Sets the value of DefaultSubPageProperty.

See also
getDefaultSubPage()

◆ isLoopSubPages()

bool isLoopSubPages ( ) const

Gets the value of LoopSubPagesProperty.

See also
setLoopSubPages()

◆ setLoopSubPages()

void setLoopSubPages ( bool  value)

Sets the value of LoopSubPagesProperty.

See also
isLoopSubPages()

Variable Documentation

◆ TransitionsProperty

PropertyType<ResourceSharedPtr> TransitionsProperty
static

Transitions property.

Transitions to be used within this PageHost node. The default value is ResourceSharedPtr().

See also
setTransitions(), getTransitions()

◆ DefaultSubPageProperty

PropertyType<string> DefaultSubPageProperty
static

DefaultSubPage property.

The default or the currently active subpage, which Kanzi automatically activates whenever this PageHost node becomes active. The default value is "".

See also
setDefaultSubPage(), getDefaultSubPage()

◆ LoopSubPagesProperty

PropertyType<bool> LoopSubPagesProperty
static

LoopSubPages property.

Loop the subpages when navigating to the next or previous subpage. The default value is true.

See also
setLoopSubPages(), isLoopSubPages()