efl::file Struct Reference

Data Structures
struct	address_const_of
struct	address_of

Public Member Functions
	file (::efl::eo::parent_type _p=(::efl::eo::parent=nullptr))
	file (Eo *eo)
	Eo Constructor. More...
	file (std::nullptr_t)
	nullptr_t Constructor. More...
	file (file const &other)
	Copy Constructor.
bool	save (std::string file_,::efl::eina::optional< std::string > key_,::efl::eina::optional< std::string > flags_) const
	Save the given image object's contents to an (image) file. More...
void	eject () const
	Eject the represented object. More...
void	file_get (const char **file_, const char **key_) const
	Retrieve the source file from where an image object is to fetch the real image data (it may be an Eet file, besides pure image ones). More...
bool	file_set (::efl::eina::optional< std::string > file_,::efl::eina::optional< std::string > key_) const
	Set the source file from where an image object must fetch the real image data (it may be an Eet file, besides pure image ones). More...
address_of	operator& ()
address_const_of	operator& () const
Public Member Functions inherited from efl::eo::concrete
	concrete (Eo *eo)
	Class constructor. More...
	concrete ()
	Default constructor. More...
	~concrete ()
	Class destructor.
	concrete (concrete const &other)
	concrete (concrete &&other)
concrete &	operator= (concrete const &other)
	Assignment operator.
concrete &	operator= (concrete &&other)
Eo *	_eo_ptr () const
	Return a pointer to the EO Object stored in this instance. More...
Eo *	_release ()
	Releases the reference from this concrete object and return the pointer to the EO Object stored in this instance. More...
void	_reset (Eo *_ptr=nullptr)
	Reset the current pointer to reference a new Eo object.
int	ref_get () const
	Get the reference count of this object. More...
void	parent_set (concrete parent)
	Set the parent of this object. More...
eina::optional< concrete >	parent_get ()
	Get the parent of this object. More...
Eo_Dbg_Info	dbg_info_get ()
	Get debug information of this object. More...
	operator bool () const

Static Public Member Functions
static Eo_Class const *	_eo_class ()

Additional Inherited Members
Protected Attributes inherited from efl::eo::concrete
Eo *	_eo_raw
	The opaque EO Object.

Constructor & Destructor Documentation

efl::file::file ( Eo *  eo )

inlineexplicit

Eo Constructor.

Constructs the object from an Eo* pointer stealing its ownership.

Parameters

eo	The Eo object pointer.

efl::file::file ( std::nullptr_t  )

inlineexplicit

nullptr_t Constructor.

Constructs an empty (null) object.

Member Function Documentation

bool efl::file::save ( std::string  file_, ::efl::eina::optional< std::string >  key_, ::efl::eina::optional< std::string >  flags_  ) const

inline

Save the given image object's contents to an (image) file.

The extension suffix on file will determine which saver module Evas is to use when saving, thus the final file's format. If the file supports multiple data stored in it (Eet ones), you can specify the key to be used as the index of the image in it.

You can specify some flags when saving the image. Currently acceptable flags are quality and compress. Eg.: "quality=100 compress=9"

Parameters

file	The filename to be used to save the image (extension obligatory).
key	The image key in the file (if an Eet one), or NULL, otherwise.
flags	String containing the flags to be used (NULL for none).

void efl::file::eject ( ) const

inline

Eject the represented object.

Get rid of and clean the pointed resource.

void efl::file::file_get ( const char **  file_, const char **  key_  ) const

inline

Retrieve the source file from where an image object is to fetch the real image data (it may be an Eet file, besides pure image ones).

You must not modify the strings on the returned pointers.

Note

Use NULL pointers on the file components you're not interested in: they'll be ignored by the function.

Parameters

file	The image file path.
key	The image key in file (if its an Eet one), or NULL, otherwise.

bool efl::file::file_set ( ::efl::eina::optional< std::string >  file_, ::efl::eina::optional< std::string >  key_  ) const

inline

Set the source file from where an image object must fetch the real image data (it may be an Eet file, besides pure image ones).

If the file supports multiple data stored in it (as Eet files do), you can specify the key to be used as the index of the image in this file.

Example:

img = evas_object_image_add(canvas);
evas_object_image_file_set(img, "/path/to/img", NULL);
err = evas_object_image_load_error_get(img);
if (err != EVAS_LOAD_ERROR_NONE)
{
fprintf(stderr, "could not load image '%s'. error string is \"%s\"\n",
valid_path, evas_load_error_str(err));
}
else
{
evas_object_image_fill_set(img, 0, 0, w, h);
evas_object_resize(img, w, h);
evas_object_show(img);
}

Parameters

file	The image file path.
key	The image key in file (if its an Eet one), or NULL, otherwise.