tbx  0.7.3
Public Member Functions | List of all members
tbx::LoadEvent Class Reference

Class with details of a file load operation. More...

#include <loader.h>

Public Member Functions

 LoadEvent (Object obj, Gadget gadget, int x, int y, int est, int type, const char *file_name, bool from_filer)
 Constructor.
 
Object destination_object ()
 Object the load is going to occur on.
 
Gadget destination_gadget ()
 Gadget for load (can be a null gadget if no gadget is involved).
 
const Pointdestination_point () const
 Location for load (screen coordinates)
 
int estimated_size () const
 Estimated size of file.
 
int file_type () const
 File type of file.
 
const std::string & file_name () const
 File name of file. More...
 
bool from_filer () const
 Check if the load is from the filer.
 
bool opener () const
 Returns true if this event is from an opener added to the main application.
 
void update_file_details (const char *file_name, int size)
 Update file details for load. More...
 

Detailed Description

Class with details of a file load operation.

This event is also used with the file open operation, but in this case only the file type, file name and from filer fields have a value.

Member Function Documentation

const std::string& tbx::LoadEvent::file_name ( ) const
inline

File name of file.

This will be either a proposed leaf name for the file when an application is checking if you can load the file or the full pathname when you are about to load the file.

void tbx::LoadEvent::update_file_details ( const char *  file_name,
int  size 
)
inline

Update file details for load.

This is called automatically by the LoaderManager before a file load


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