KGAPI2::Drive::Drives::BackgroundImageFile Class Reference

#include <drives.h>

Public Member Functions
	BackgroundImageFile (const BackgroundImageFile &other)
QString	id () const
bool	operator!= (const BackgroundImageFile &other) const
bool	operator== (const BackgroundImageFile &other) const
void	setId (const QString &id) const
void	setWidth (float width) const
void	setXCoordinate (float xCoordinate) const
void	setYCoordinate (float yCoordinate) const
float	width () const
float	xCoordinate () const
float	yCoordinate () const

Detailed Description

Drives::BackgroundImageFile holds the structure used for backgroundImageFile property.

Definition at line 290 of file drives.h.

Constructor & Destructor Documentation

BackgroundImageFile() [1/2]

Drives::BackgroundImageFile::BackgroundImageFile

(

)

Definition at line 266 of file drives.cpp.

BackgroundImageFile() [2/2]

Drives::BackgroundImageFile::BackgroundImageFile

(

const BackgroundImageFile &

other

)

Definition at line 271 of file drives.cpp.

Member Function Documentation

id()

QString Drives::BackgroundImageFile::id

(

)

const

Returns the ID of an image file in Google Drive to use for the background image.

Definition at line 287 of file drives.cpp.

operator!=()

bool KGAPI2::Drive::Drives::BackgroundImageFile::operator!= ( const BackgroundImageFile & other ) const

inline

Definition at line 304 of file drives.h.

operator==()

bool Drives::BackgroundImageFile::operator==

(

const BackgroundImageFile &

other

)

const

Definition at line 278 of file drives.cpp.

setId()

void Drives::BackgroundImageFile::setId

(

const QString &

id

)

const

Sets the ID of an image file in Google Drive to use for the background image.

Parameters

id

Definition at line 292 of file drives.cpp.

setWidth()

void Drives::BackgroundImageFile::setWidth

(

float

width

)

const

Sets the width of the cropped image in the closed range of 0 to 1.

This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.

Parameters

width

Definition at line 322 of file drives.cpp.

setXCoordinate()

void Drives::BackgroundImageFile::setXCoordinate

(

float

xCoordinate

)

const

Returns the X coordinate of the upper left corner of the cropping area in the background image.

This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.

Parameters

xCoordinate

Definition at line 302 of file drives.cpp.

setYCoordinate()

void Drives::BackgroundImageFile::setYCoordinate

(

float

yCoordinate

)

const

Sets the Y coordinate of the upper left corner of the cropping area in the background image.

This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.

Parameters

yCoordinate

Definition at line 312 of file drives.cpp.

width()

float Drives::BackgroundImageFile::width

(

)

const

Returns the width of the cropped image in the closed range of 0 to 1.

This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.

Definition at line 317 of file drives.cpp.

xCoordinate()

float Drives::BackgroundImageFile::xCoordinate

(

)

const

Returns the X coordinate of the upper left corner of the cropping area in the background image.

This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.

Definition at line 297 of file drives.cpp.

yCoordinate()

float Drives::BackgroundImageFile::yCoordinate

(

)

const

Returns the Y coordinate of the upper left corner of the cropping area in the background image.

This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.

Definition at line 307 of file drives.cpp.

---

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

• drives.h
• drives.cpp