File: wizard.cpp

package info (click to toggle)
wxformbuilder 4.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,908 kB
  • sloc: cpp: 37,318; xml: 6,611; javascript: 1,353; python: 94; sh: 62; makefile: 62
file content (193 lines) | stat: -rw-r--r-- 7,340 bytes parent folder | download
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
///////////////////////////////////////////////////////////////////////////////
//
// wxFormBuilder - A Visual Dialog Editor for wxWidgets.
// Copyright (C) 2005 José Antonio Hurtado
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Written by
//   Andrea Zanellato - zanellato.andrea@gmail.com
//   based on original wizard.cpp file in wxWidgets source code
//
///////////////////////////////////////////////////////////////////////////////

#include "wizard.h"


wxDEFINE_EVENT(wxFB_EVT_WIZARD_PAGE_CHANGED, WizardEvent);
wxDEFINE_EVENT(wxFB_EVT_WIZARD_PAGE_CHANGING, WizardEvent);
wxDEFINE_EVENT(wxFB_EVT_WIZARD_CANCEL, WizardEvent);
wxDEFINE_EVENT(wxFB_EVT_WIZARD_FINISHED, WizardEvent);
wxDEFINE_EVENT(wxFB_EVT_WIZARD_HELP, WizardEvent);
wxDEFINE_EVENT(wxFB_EVT_WIZARD_PAGE_SHOWN, WizardEvent);


Wizard::Wizard(wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style) :
  WizardBase(parent, id, pos, size, style), m_page(nullptr)
{
    this->Connect(wxID_ANY, wxFB_EVT_WIZARD_PAGE_CHANGED, WizardEventHandler(Wizard::OnWizEvent));
    this->Connect(wxID_ANY, wxFB_EVT_WIZARD_PAGE_CHANGING, WizardEventHandler(Wizard::OnWizEvent));
    this->Connect(wxID_ANY, wxFB_EVT_WIZARD_CANCEL, WizardEventHandler(Wizard::OnWizEvent));
    this->Connect(wxID_ANY, wxFB_EVT_WIZARD_FINISHED, WizardEventHandler(Wizard::OnWizEvent));
    this->Connect(wxID_ANY, wxFB_EVT_WIZARD_HELP, WizardEventHandler(Wizard::OnWizEvent));
}

Wizard::~Wizard()
{
    this->Disconnect(wxID_ANY, wxFB_EVT_WIZARD_PAGE_CHANGED, WizardEventHandler(Wizard::OnWizEvent));
    this->Disconnect(wxID_ANY, wxFB_EVT_WIZARD_PAGE_CHANGING, WizardEventHandler(Wizard::OnWizEvent));
    this->Disconnect(wxID_ANY, wxFB_EVT_WIZARD_CANCEL, WizardEventHandler(Wizard::OnWizEvent));
    this->Disconnect(wxID_ANY, wxFB_EVT_WIZARD_FINISHED, WizardEventHandler(Wizard::OnWizEvent));
    this->Disconnect(wxID_ANY, wxFB_EVT_WIZARD_HELP, WizardEventHandler(Wizard::OnWizEvent));
}


void Wizard::SetBitmap(const wxBitmap& bitmap)
{
    m_statbmp->SetBitmap(bitmap);

    auto pageSize = m_sizerBmpAndPage->GetSize();
    pageSize.IncTo(wxSize(0, bitmap.GetHeight()));
    m_sizerBmpAndPage->SetMinSize(pageSize);
}


void Wizard::AddPage(WizardPageSimple* page)
{
    m_page = page;                          // Update current page,
    m_pages.push_back(page);                // add it to internal page array,
    const auto pageCount = m_pages.size();  // Internal page array count

    for (size_t i = 0; i < pageCount; ++i) {
        m_pages[i]->Hide();
    }
    page->Show();

    m_sizerPage->Add(page, 1, wxEXPAND, 0);  // insert it into the page sizer,
    Layout();                                // update layout,

    if (pageCount == 1) {                   // First page: no previous, no next
        m_btnNext->Enable(true);            // but enable the next page button
        m_btnNext->SetLabel(_("&Finish"));  // because it acts as 'finish'
    } else if (pageCount == 2) {            // Enable previous page button:
        m_btnPrev->Enable(true);            // from now on everything is done in the OnBackOrNext() event
    }                                       // when user clicks on 'back' or 'next' buttons.
}

size_t Wizard::GetPageIndex(WizardPageSimple* wizpage) const
{
    for (size_t i = 0; i < m_pages.size(); ++i) {
        if (m_pages[i] == wizpage) {
            return i;
        }
    }

    return static_cast<size_t>(-1);
}


void Wizard::SetSelection(size_t pageIndex)
{
    const auto pageCount = m_pages.size();         // Internal page array count
    if (pageIndex < pageCount) {                   // Is it a valid index?
        const auto hasPrev = (pageIndex > 0);              // Has this page a previous one,
        const auto hasNext = (pageIndex < pageCount - 1);  // or another after it?

        m_page = m_pages[pageIndex];  // Yes, update current page and

        m_btnPrev->Enable(hasPrev);  // enable 'back' button if a previous page exists,
        wxString label = (hasNext ? _("&Next >") : _("&Finish"));
        if (label != m_btnNext->GetLabel()) {  // set the correct label on next button
            m_btnNext->SetLabel(label);
        }

        m_btnNext->SetDefault();  // and as default one, user needs it ready to go on.
    }
}


void Wizard::OnBackOrNext(wxCommandEvent& event)
{
    auto pageIndex = GetPageIndex(m_page);  // Get index of previous selected page
    auto forward = (event.GetEventObject() == m_btnNext);

    if (forward) {
        ++pageIndex;
    } else {
        --pageIndex;
    }
    SetSelection(pageIndex);

    WizardEvent eventChanged(wxFB_EVT_WIZARD_PAGE_CHANGED, GetId(), forward, m_page);
    m_page->GetEventHandler()->ProcessEvent(eventChanged);
}

void Wizard::OnHelp(wxCommandEvent&)
{
    // this function probably can never be called when we don't have an active
    // page, but a small extra check won't hurt
    if (m_page) {
        // Create and send the help event to the specific page handler
        // event data contains the active page so that context-sensitive
        // help is possible
        WizardEvent eventHelp(wxFB_EVT_WIZARD_HELP, GetId(), true, m_page);
        m_page->GetEventHandler()->ProcessEvent(eventHelp);
    }
}

void Wizard::OnCancel(wxCommandEvent&)
{
    WizardEvent eventCancel(wxFB_EVT_WIZARD_CANCEL, GetId(), false, m_page);
    GetEventHandler()->ProcessEvent(eventCancel);
}


void Wizard::OnWizEvent(WizardEvent& event)
{
    if (event.IsAllowed()) {
        const auto eventType = event.GetEventType();

        if (eventType == wxFB_EVT_WIZARD_PAGE_CHANGED) {
            for (size_t i = 0; i < m_pages.size(); ++i) {
                m_pages[i]->Hide();
            }
            event.GetPage()->Show();

            Layout();
        }
#if 0
        else if (eventType == wxFB_EVT_WIZARD_PAGE_CHANGING) {
            wxLogDebug(wxT("Wizard Page changing."));
        } else if (eventType == wxFB_EVT_WIZARD_CANCEL) {
            wxLogDebug(wxT("Wizard Cancel button was pressed."));
        } else if (eventType == wxFB_EVT_WIZARD_HELP) {
            wxLogDebug(wxT("Wizard Help button was pressed."));
        } else if (eventType == wxFB_EVT_WIZARD_FINISHED) {
            wxLogDebug(wxT("Wizard Finish button was pressed."));
        } else if (eventType == wxFB_EVT_WIZARD_PAGE_SHOWN) {
            wxLogDebug(wxT("Wizard Page shown."));
        }
#endif
    }
}


WizardEvent::WizardEvent(wxEventType type, int id, bool direction, WizardPageSimple* page) : wxNotifyEvent(type, id)
{
    // Modified 10-20-2001 Robert Cavanaugh
    // add the active page to the event data
    m_direction = direction;
    m_page = page;
}