List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
setBackground Class Referencefinal

Inherits Function.

Description

Changes the background selected by the user; adds background to the list of installed backgrounds.

Returns object_ptr<Background>.

Public Fields

object_ptr< InputBackgroundbackground_
 The input background to use; pass null to create a new filled backgrounds or to remove the current background.
 
object_ptr< BackgroundTypetype_
 Background type; pass null to use the default type of the remote background or to remove the current background.
 
bool for_dark_theme_
 True, if the background is chosen for dark theme.
 

Public Types

using ReturnType = object_ptr< background >
 Typedef for the type returned by the function.
 

Public Instance Methods

 setBackground ()
 
 setBackground (object_ptr< InputBackground > &&background_, object_ptr< BackgroundType > &&type_, bool for_dark_theme_)
 
std::int32_t get_id () const final
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = -1035439225
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ setBackground() [1/2]

Default constructor for a function, which changes the background selected by the user; adds background to the list of installed backgrounds.

Returns object_ptr<Background>.

◆ setBackground() [2/2]

setBackground ( object_ptr< InputBackground > &&  background_,
object_ptr< BackgroundType > &&  type_,
bool  for_dark_theme_ 
)

Creates a function, which changes the background selected by the user; adds background to the list of installed backgrounds.

Returns object_ptr<Background>.

Parameters
[in]background_The input background to use; pass null to create a new filled backgrounds or to remove the current background.
[in]type_Background type; pass null to use the default type of the remote background or to remove the current background.
[in]for_dark_theme_True, if the background is chosen for dark theme.

Method Documentation

◆ get_id()

std::int32_t get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements TlObject.

◆ store()

void store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


The documentation for this class was generated from the following file: