Cinder  0.8.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
cinder::app::FileDropEvent Class Reference

Represents a file-drop event, typically received from Windows Explorer or Mac OS X Finder. More...

#include <FileDropEvent.h>

Inheritance diagram for cinder::app::FileDropEvent:
[legend]

Public Member Functions

 FileDropEvent (WindowRef win, int aX, int aY, const std::vector< fs::path > &aFiles)
 
int getX () const
 Returns the X coordinate measured in points of the mouse during the event. More...
 
int getY () const
 Returns the Y coordinate measured in points of the mouse during the event. More...
 
Vec2i getPos () const
 Returns the coordinates measured in points of the mouse during the event. More...
 
const std::vector< fs::path > & getFiles () const
 Returns the vector of file paths which were dropped. More...
 
size_t getNumFiles () const
 Returns the number of files dropped during the event. More...
 
const fs::path & getFile (size_t index) const
 Returns the path for file number index. More...
 
bool isHandled () const
 Returns whether this event has been marked as handled by one of its slots, terminating the normal iteration of the event's slots. More...
 
void setHandled (bool handled=true)
 Marks the event as handled, terminating the normal iteration of the event's slots. More...
 
WindowRef getWindow () const
 Returns the Window in which the MouseEvent occurred. More...
 
void setWindow (const WindowRef &window)
 

Public Attributes

bool mHandled
 
WindowRef mWindow
 

Detailed Description

Represents a file-drop event, typically received from Windows Explorer or Mac OS X Finder.

Constructor & Destructor Documentation

cinder::app::FileDropEvent::FileDropEvent ( WindowRef  win,
int  aX,
int  aY,
const std::vector< fs::path > &  aFiles 
)

Member Function Documentation

int cinder::app::FileDropEvent::getX ( ) const

Returns the X coordinate measured in points of the mouse during the event.

int cinder::app::FileDropEvent::getY ( ) const

Returns the Y coordinate measured in points of the mouse during the event.

Vec2i cinder::app::FileDropEvent::getPos ( ) const

Returns the coordinates measured in points of the mouse during the event.

const std::vector<fs::path>& cinder::app::FileDropEvent::getFiles ( ) const

Returns the vector of file paths which were dropped.

size_t cinder::app::FileDropEvent::getNumFiles ( ) const

Returns the number of files dropped during the event.

const fs::path& cinder::app::FileDropEvent::getFile ( size_t  index) const

Returns the path for file number index.

bool cinder::app::Event::isHandled ( ) const
inherited

Returns whether this event has been marked as handled by one of its slots, terminating the normal iteration of the event's slots.

void cinder::app::Event::setHandled ( bool  handled = true)
inherited

Marks the event as handled, terminating the normal iteration of the event's slots.

WindowRef cinder::app::Event::getWindow ( ) const
inherited

Returns the Window in which the MouseEvent occurred.

void cinder::app::Event::setWindow ( const WindowRef window)
inherited

Member Data Documentation

bool cinder::app::Event::mHandled
inherited
WindowRef cinder::app::Event::mWindow
inherited

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