Vuo  2.3.2
Typedefs | Functions
VuoWindowDescription

Description

The settings for a window, such as its title and whether it is full-screen.

The settings do not reference any particular window. They can be applied to more than one window.

Typedefs

typedef VuoList_VuoWindowProperty VuoWindowDescription
 The settings for a window, such as its title and whether it is full-screen. More...
 

Functions

VuoWindowDescription VuoWindowDescription_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoWindowDescription_getJson (const VuoWindowDescription value)
 Encodes value as a JSON object. More...
 
char * VuoWindowDescription_getSummary (const VuoWindowDescription value)
 Returns a compact string representation of value. More...
 
VuoWindowDescription VuoWindowDescription_copy (const VuoWindowDescription value)
 Returns a copy that can be modified without affecting the original. More...
 
void VuoWindowDescription_setProperty (VuoWindowDescription value, VuoWindowProperty property)
 Changes a window setting. More...
 
VuoList_VuoWindowProperty VuoWindowDescription_getWindowProperties (const VuoWindowDescription value)
 Returns the settings stored in this window description in the format of a VuoWindowProperty list. More...
 
VuoWindowDescription VuoWindowDescription_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoWindowDescription_getString (const VuoWindowDescription value)
 Automatically generated function. More...
 
void VuoWindowDescription_retain (VuoWindowDescription value)
 Automatically generated function. More...
 
void VuoWindowDescription_release (VuoWindowDescription value)
 Automatically generated function. More...
 

Typedef Documentation

◆ VuoWindowDescription

The settings for a window, such as its title and whether it is full-screen.

For convenience the implementation is based on VuoWindowProperty, the predecessor of this type.

Changed in Vuo 2.0.0:
New.

Definition at line 31 of file VuoWindowDescription.h.

Function Documentation

◆ VuoWindowDescription_copy()

VuoWindowDescription VuoWindowDescription_copy ( const VuoWindowDescription  value)

Returns a copy that can be modified without affecting the original.

Changed in Vuo 2.0.0:
New.

Definition at line 61 of file VuoWindowDescription.c.

◆ VuoWindowDescription_getJson()

struct json_object* VuoWindowDescription_getJson ( const VuoWindowDescription  value)

Encodes value as a JSON object.

Changed in Vuo 2.0.0:
New.

Definition at line 41 of file VuoWindowDescription.c.

◆ VuoWindowDescription_getString()

char* VuoWindowDescription_getString ( const VuoWindowDescription  value)

Automatically generated function.

◆ VuoWindowDescription_getSummary()

char* VuoWindowDescription_getSummary ( const VuoWindowDescription  value)

Returns a compact string representation of value.

Changed in Vuo 2.0.0:
New.

Definition at line 51 of file VuoWindowDescription.c.

◆ VuoWindowDescription_getWindowProperties()

VuoList_VuoWindowProperty VuoWindowDescription_getWindowProperties ( const VuoWindowDescription  value)

Returns the settings stored in this window description in the format of a VuoWindowProperty list.

Changed in Vuo 2.0.0:
New.

Definition at line 84 of file VuoWindowDescription.c.

◆ VuoWindowDescription_makeFromJson()

VuoWindowDescription VuoWindowDescription_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Changed in Vuo 2.0.0:
New.

Definition at line 31 of file VuoWindowDescription.c.

◆ VuoWindowDescription_makeFromString()

VuoWindowDescription VuoWindowDescription_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoWindowDescription_release()

void VuoWindowDescription_release ( VuoWindowDescription  value)

Automatically generated function.

◆ VuoWindowDescription_retain()

void VuoWindowDescription_retain ( VuoWindowDescription  value)

Automatically generated function.

◆ VuoWindowDescription_setProperty()

void VuoWindowDescription_setProperty ( VuoWindowDescription  value,
VuoWindowProperty  property 
)

Changes a window setting.

Changed in Vuo 2.0.0:
New.

Definition at line 74 of file VuoWindowDescription.c.