summaryrefslogtreecommitdiff
path: root/wx+/file_drop.h
blob: fb56c5d974c268c30a25b871e3c7c0c8733db91a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// **************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: http://www.gnu.org/licenses/gpl.html       *
// * Copyright (C) Zenju (zenju AT gmx DOT de) - All Rights Reserved        *
// **************************************************************************

#ifndef FILE_DROP_H_INCLUDED
#define FILE_DROP_H_INCLUDED

#include <vector>
#include <wx/window.h>
#include <wx/event.h>
#include <wx/dnd.h>

namespace zen
{
//register simple file drop event (without issue of freezing dialogs and without wxFileDropTarget overdesign)
//CAVEAT: a drop target window must not be directly or indirectly contained within a wxStaticBoxSizer until the following wxGTK bug
//is fixed. According to wxWidgets release cycles this is expected to be: never http://trac.wxwidgets.org/ticket/2763

//1. setup a window to emit EVENT_DROP_FILE
void setupFileDrop(wxWindow& wnd);

//2. register events:
//wnd.Connect   (EVENT_DROP_FILE, FileDropEventHandler(MyDlg::OnFilesDropped), nullptr, this);
//wnd.Disconnect(EVENT_DROP_FILE, FileDropEventHandler(MyDlg::OnFilesDropped), nullptr, this);

//3. do something:
//void MyDlg::OnFilesDropped(FileDropEvent& event);
















namespace impl
{
inline
wxEventType createNewEventType()
{
    //inline functions have external linkage by default => this static is also extern, i.e. program wide unique! but defined in a header... ;)
    static wxEventType dummy = wxNewEventType();
    return dummy;
}
}


//define new event type
const wxEventType EVENT_DROP_FILE = impl::createNewEventType();

class FileDropEvent : public wxCommandEvent
{
public:
    FileDropEvent(const std::vector<wxString>& filesDropped, const wxWindow& dropWindow, wxPoint dropPos) :
        wxCommandEvent(EVENT_DROP_FILE),
        filesDropped_(filesDropped),
        dropWindow_(dropWindow),
        dropPos_(dropPos) {}

    virtual wxEvent* Clone() const { return new FileDropEvent(*this); }

    const std::vector<wxString>& getFiles()        const { return filesDropped_; }
    const wxWindow&              getDropWindow()   const { return dropWindow_;   }
    wxPoint                      getDropPosition() const { return dropPos_;      } //position relative to drop window

private:
    const std::vector<wxString> filesDropped_;
    const wxWindow& dropWindow_;
    const wxPoint dropPos_;
};

typedef void (wxEvtHandler::*FileDropEventFunction)(FileDropEvent&);

#define FileDropEventHandler(func) \
    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(FileDropEventFunction, &func)


namespace impl
{
class WindowDropTarget : public wxFileDropTarget
{
public:
    WindowDropTarget(wxWindow& dropWindow) : dropWindow_(dropWindow) {}

private:
    virtual bool OnDropFiles(wxCoord x, wxCoord y, const wxArrayString& fileArray)
    {
        std::vector<wxString> filenames(fileArray.begin(), fileArray.end());
        if (!filenames.empty())
        {
            //create a custom event on drop window: execute event after file dropping is completed! (after mouse is released)
            FileDropEvent evt(filenames, dropWindow_, wxPoint(x, y));
            if (wxEvtHandler* handler = dropWindow_.GetEventHandler())
                handler->AddPendingEvent(evt);
        }
        return true;
    }

    wxWindow& dropWindow_;
};
}


inline
void setupFileDrop(wxWindow& wnd)
{
    wnd.SetDropTarget(new impl::WindowDropTarget(wnd)); //takes ownership
}
}

#endif // FILE_DROP_H_INCLUDED
bgstack15