/* Copyright (C) 2009-2010 wxLauncher Team 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. */ #include "generated/configure_launcher.h" #include "controls/FlagListBox.h" #include "apis/ProfileProxy.h" #include "apis/SkinManager.h" #include "global/ids.h" #include "global/MemoryDebugging.h" FlagListCheckBox::FlagListCheckBox( wxWindow* parent, const wxString& label, const wxString& flagString) : wxCheckBox(parent, wxID_ANY, label), flagString(flagString) { wxASSERT(parent != NULL); wxASSERT(!flagString.IsEmpty()); } void FlagListCheckBox::OnClicked(wxCommandEvent &WXUNUSED(event)) { ProfileProxy::GetProxy()->SetFlag(this->flagString, this->IsChecked()); wxLogDebug(_T("flag %s is now %s"), flagString.c_str(), this->IsChecked() ? _T("on") : _T("off")); } FlagListCheckBoxItem::FlagListCheckBoxItem(const wxString& fsoCategory) : fsoCategory(fsoCategory), checkBox(NULL), checkBoxSizer(NULL), shortDescription(wxEmptyString), flagString(wxEmptyString), isRecommendedFlag(false) { wxASSERT(!fsoCategory.IsEmpty()); } FlagListCheckBoxItem::FlagListCheckBoxItem( FlagListCheckBox& checkBox, wxSizer& checkBoxSizer, const wxString& shortDescription, const wxString& flagString, const bool isRecommendedFlag) : fsoCategory(wxEmptyString), checkBox(&checkBox), checkBoxSizer(&checkBoxSizer), shortDescription(shortDescription), flagString(flagString), isRecommendedFlag(isRecommendedFlag) { // shortDescription can be empty wxASSERT(!flagString.IsEmpty()); } FlagListCheckBoxItem::~FlagListCheckBoxItem() { delete this->checkBoxSizer; } #include // Magic Incantation WX_DEFINE_LIST(FlagListCheckBoxItems); LAUNCHER_DEFINE_EVENT_TYPE(EVT_FLAG_LIST_BOX_READY); void FlagListBox::RegisterFlagListBoxReady(wxEvtHandler *handler) { wxASSERT_MSG(flagListBoxReadyHandlers.IndexOf(handler) == wxNOT_FOUND, wxString::Format( _T("RegisterFlagListBoxReady(): Handler at %p already registered."), handler)); this->flagListBoxReadyHandlers.Append(handler); } void FlagListBox::UnRegisterFlagListBoxReady(wxEvtHandler *handler) { wxASSERT_MSG(flagListBoxReadyHandlers.IndexOf(handler) != wxNOT_FOUND, wxString::Format( _T("UnRegisterFlagListBoxReady(): Handler at %p not registered."), handler)); this->flagListBoxReadyHandlers.DeleteObject(handler); } void FlagListBox::GenerateFlagListBoxReady() { wxASSERT(this->IsReady()); wxASSERT_MSG(!this->isReadyEventGenerated, _T("GenerateFlagListBoxReady() was called a second time.")); wxCommandEvent event(EVT_FLAG_LIST_BOX_READY, wxID_NONE); wxLogDebug(_T("Generating EVT_FLAG_LIST_BOX_READY event")); for (EventHandlers::iterator iter = this->flagListBoxReadyHandlers.begin(), end = this->flagListBoxReadyHandlers.end(); iter != end; ++iter) { wxEvtHandler* current = *iter; current->AddPendingEvent(event); wxLogDebug(_T(" Sent EVT_FLAG_LIST_BOX_READY event to %p"), current); } this->isReadyEventGenerated = true; } struct FlagInfo { wxString flag; wxString category; bool takesArg; }; #include "datastructures/FlagInfo.cpp" #define WIDTH_OF_CHECKBOX 16 // allows flag checkbox and text to be lined up, while avoiding // visual collisions with flag category lines const int ITEM_VERTICAL_OFFSET = 2; // in pixels #if IS_LINUX const int VERTICAL_OFFSET_MULTIPLIER = 2; // in pixels #else const int VERTICAL_OFFSET_MULTIPLIER = 1; // in pixels #endif FlagListBox::FlagListBox(wxWindow* parent) : wxVListBox(parent,ID_FLAGLISTBOX), isReadyEventGenerated(false), isReady(false), flagsLoaded(false), flagData(NULL), areCheckBoxesGenerated(false) { } void FlagListBox::AcceptFlagData(FlagFileData* flagData) { wxCHECK_RET(flagData != NULL, _T("AcceptFlagData(): flagData is null.")); wxCHECK_RET(this->flagData == NULL, _T("AcceptFlagData(): flag list box given flag data twice.")); this->isReady = true; this->flagData = flagData; FlagListBoxData* data = this->flagData->GenerateFlagListBoxData(); wxCHECK_RET(data != NULL, _T("AcceptFlagData(): FlagFileData::GenerateFlagListBoxData() returned null.")); this->GenerateCheckBoxes(*data); this->SetItemCount(flagData->GetItemCount()); this->GenerateFlagListBoxReady(); } void FlagListBox::GenerateCheckBoxes(const FlagListBoxData& data) { wxASSERT(!data.IsEmpty()); wxASSERT_MSG(!this->areCheckBoxesGenerated, _T("Attempted to generate checkboxes a second time.")); FlagListCheckBox* checkBox; wxSizer* checkBoxSizer; for (FlagListBoxData::const_iterator dataIter = data.begin(); dataIter != data.end(); ++dataIter) { FlagListBoxDataItem* item = *dataIter; if (!item->fsoCategory.IsEmpty()) { this->checkBoxes.Append( new FlagListCheckBoxItem(item->fsoCategory)); continue; } checkBox = new FlagListCheckBox( this, wxEmptyString, item->flagString); checkBox->Hide(); // we don't yet know where it should appear, so hide checkBox->Connect( checkBox->GetId(), wxEVT_COMMAND_CHECKBOX_CLICKED, wxCommandEventHandler(FlagListCheckBox::OnClicked)); checkBoxSizer = new wxBoxSizer(wxVERTICAL); checkBoxSizer->AddSpacer(ITEM_VERTICAL_OFFSET); checkBoxSizer->Add(checkBox); this->checkBoxes.Append( new FlagListCheckBoxItem(*checkBox, *checkBoxSizer, item->shortDescription, item->flagString, item->isRecommendedFlag)); } this->areCheckBoxesGenerated = true; } FlagListBox::~FlagListBox() { FlagFileData* temp = this->flagData; this->flagData = NULL; delete temp; this->checkBoxes.Clear(); } FlagListCheckBoxItem* FlagListBox::FindFlagAt(size_t n) const { wxCHECK_MSG(this->IsReady(), NULL, _T("FindFlagAt() called when flag list box is not ready")); wxCHECK_MSG(n >= 0 && n < this->checkBoxes.GetCount(), NULL, wxString::Format(_T("FindFlagAt() called with out-of-range value %lu"), n)); return this->checkBoxes[n]; } void FlagListBox::OnDrawItem(wxDC &dc, const wxRect &rect, size_t n) const { #if IS_WIN32 // replace the ugly default font with one based on the system default wxFont font(SkinSystem::GetSkinSystem()->GetFont()); dc.SetFont(font); #endif if (this->IsReady()) { FlagListCheckBoxItem* item = this->FindFlagAt(n); wxCHECK_RET(item != NULL, _T("Flag pointer is null")); if (item->GetCheckBox() != NULL) { if (item->IsRecommendedFlag()) { dc.DrawBitmap( SkinSystem::GetSkinSystem()->GetIdealIcon(), rect.x, rect.y); } item->GetCheckBox()->Show(); item->GetCheckBoxSizer()->SetDimension( rect.x + SkinSystem::IdealIconWidth, rect.y, SkinSystem::IdealIconWidth, rect.height); if (item->GetShortDescription().IsEmpty()) { dc.DrawText(wxString(_T(" ")) + item->GetFlagString(), rect.x + SkinSystem::IdealIconWidth + WIDTH_OF_CHECKBOX, rect.y + (VERTICAL_OFFSET_MULTIPLIER*ITEM_VERTICAL_OFFSET)); } else { dc.DrawText(wxString(_T(" ")) + item->GetShortDescription(), rect.x + SkinSystem::IdealIconWidth + WIDTH_OF_CHECKBOX, rect.y + (VERTICAL_OFFSET_MULTIPLIER*ITEM_VERTICAL_OFFSET)); } } else { // draw a category wxASSERT(!item->GetFsoCategory().IsEmpty()); #if IS_WIN32 font.SetWeight(wxFONTWEIGHT_BOLD); dc.SetTextForeground(*wxWHITE); dc.SetFont(font); #endif dc.DrawText(wxString(_T(" ")) + item->GetFsoCategory(), rect.x + SkinSystem::IdealIconWidth + WIDTH_OF_CHECKBOX, rect.y + (VERTICAL_OFFSET_MULTIPLIER*ITEM_VERTICAL_OFFSET)); #if IS_WIN32 dc.SetTextForeground(*wxBLACK); #endif } } else { wxASSERT_MSG( n == 0, _T("FLAGLISTBOX: Trying to draw background n != 0") ); } } wxCoord FlagListBox::OnMeasureItem(size_t n) const { if ( this->IsReady()) { return SkinSystem::IdealIconHeight; } else { return this->GetSize().y; } } void FlagListBox::OnDrawBackground(wxDC &dc, const wxRect &rect, size_t n) const { wxColour background = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW); if (this->IsReady()) { FlagListCheckBoxItem* item = FindFlagAt(n); if (item != NULL && item->GetFlagString().IsEmpty()) { // category header background = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT); } } dc.DestroyClippingRegion(); wxBrush b(background); dc.SetPen(wxPen(background)); dc.SetBrush(b); dc.SetBackground(b); dc.DrawRectangle(rect); } void FlagListBox::OnDoubleClickFlag(wxCommandEvent &WXUNUSED(event)) { wxCHECK_RET(this->IsReady(), _T("OnDoubleClickFlag() called when flag list box is not ready.")); const wxString* webURL = this->flagData->GetWebURL(this->GetSelection()); wxCHECK_RET(webURL != NULL, _T("GetWebURL() returned NULL, which shouldn't happen.")); if (!webURL->IsEmpty()) { wxLaunchDefaultBrowser(*webURL); } } void FlagListBox::LoadEnabledFlags() { wxCHECK_RET(this->IsReady(), _T("LoadEnabledFlags() called when flag list box is not ready.")); wxCHECK_RET(ProfileProxy::GetProxy()->IsFlagDataReady(), _T("LoadEnabledFlags() called when proxy flag data is not ready.")); wxCHECK_RET(!this->flagsLoaded, _T("LoadEnabledFlags() called when flags have already been loaded.")); std::vector enabledFlags( ProfileProxy::GetProxy()->GetEnabledFlags()); for (std::vector::const_iterator it = enabledFlags.begin(), end = enabledFlags.end(); it != end; ++it) { const wxString& flag(*it); wxCHECK_RET(this->SetFlag(flag, true), wxString::Format( _T("LoadEnabledFlags(): Couldn't find flag %s"), flag.c_str())); } this->flagsLoaded = true; } bool FlagListBox::SetFlag( const wxString& flagString, const bool state, const bool updateProxy) { wxCHECK_MSG(this->IsReady(), false, _T("SetFlag() called when flag list box is not ready.")); wxCHECK_MSG(ProfileProxy::GetProxy()->IsFlagDataReady(), false, _T("SetFlag() called when proxy flag data is not ready.")); wxCHECK_MSG(!flagString.IsEmpty(), false, _T("SetFlag() called with empty flagString.")); for (FlagListCheckBoxItems::iterator it = this->checkBoxes.begin(), end = this->checkBoxes.end(); it != end; ++it) { FlagListCheckBoxItem* item = *it; if (!item->GetFlagString().IsEmpty() && item->GetFlagString() == flagString) { item->GetCheckBox()->SetValue(state); if (updateProxy) { ProfileProxy::GetProxy()->SetFlag(flagString, state); } return true; } } return false; } BEGIN_EVENT_TABLE(FlagListBox, wxVListBox) EVT_LISTBOX_DCLICK(ID_FLAGLISTBOX, FlagListBox::OnDoubleClickFlag) END_EVENT_TABLE() bool FlagListBox::SetFlagSet(const wxString& setToFind) { wxASSERT(!setToFind.IsEmpty()); wxCHECK_MSG(this->IsReady(), false, _T("SetFlagSet() called when flag list box is not ready.")); const FlagSet* flagSet = this->flagData->GetFlagSet(setToFind); if ( flagSet == NULL ) { return false; } wxArrayString::const_iterator disableIter = flagSet->flagsToDisable.begin(); while ( disableIter != flagSet->flagsToDisable.end() ) { if (!this->SetFlag(*disableIter, false, true)) { wxLogWarning(_T("Could not find flag %s to disable for flag set %s."), disableIter->c_str(), setToFind.c_str()); } disableIter++; } wxArrayString::const_iterator enableIter = flagSet->flagsToEnable.begin(); while ( enableIter != flagSet->flagsToEnable.end() ) { if (!this->SetFlag(*enableIter, true, true)) { wxLogWarning(_T("Could not find flag %s to enable for flag set %s."), enableIter->c_str(), setToFind.c_str()); } enableIter++; } return true; } void FlagListBox::GetFlagSets(wxArrayString& arr) const { wxASSERT(arr.IsEmpty()); wxCHECK_RET(this->IsReady(), _T("GetFlagSets() called when flag list box is not ready.")); this->flagData->GetFlagSetNames(arr); }