Skip to content

Commit

Permalink
#5127: Harmonise the method first letter casing in the wxutil classes…
Browse files Browse the repository at this point in the history 
…. When using types deriving from wxWidgets the mixed case is looking weird.
  • Loading branch information
@codereader
codereader committed Jan 2, 2021
1 parent dbb8f97 commit ebc5c97
Show file tree
Hide file tree
Showing 6 changed files with 84 additions and 87 deletions.
6 changes: 3 additions & 3 deletions libs/wxutil/EntityClassChooser.cpp
View file
Expand Up @@ -256,12 +256,12 @@ void EntityClassChooser::onMainFrameShuttingDown()

void EntityClassChooser::loadEntityClasses()
{
_treeView->populate(std::make_shared<ThreadedEntityClassLoader>(_columns));
_treeView->Populate(std::make_shared<ThreadedEntityClassLoader>(_columns));
}

void EntityClassChooser::setSelectedEntityClass(const std::string& eclass)
{
_treeView->setSelection(eclass);
_treeView->SetSelectedFullname(eclass);
}

const std::string& EntityClassChooser::getSelectedEntityClass() const
Expand Down Expand Up @@ -305,7 +305,7 @@ void EntityClassChooser::setupTreeView()

_treeView = new ResourceTreeView(parent, _treeStore, _columns);
_treeView->AddSearchColumn(_columns.iconAndName);
_treeView->setExpandTopLevelItemsAfterPopulation(true);
_treeView->SetExpandTopLevelItemsAfterPopulation(true);

_treeView->Bind(wxEVT_DATAVIEW_SELECTION_CHANGED, &EntityClassChooser::onSelectionChanged, this);

Expand Down
68 changes: 34 additions & 34 deletions libs/wxutil/dataview/ResourceTreeView.cpp
View file
Expand Up @@ -56,12 +56,12 @@ ResourceTreeView::~ResourceTreeView()
}
}

const TreeModel::Ptr& ResourceTreeView::getTreeModel()
const TreeModel::Ptr& ResourceTreeView::GetTreeModel()
{
return _treeStore;
}

void ResourceTreeView::setTreeModel(const TreeModel::Ptr& model)
void ResourceTreeView::SetTreeModel(const TreeModel::Ptr& model)
{
_treeStore = model;
_emptyFavouritesLabel = wxDataViewItem();
Expand All @@ -73,17 +73,17 @@ void ResourceTreeView::setTreeModel(const TreeModel::Ptr& model)
return;
}

setupTreeModelFilter();
SetupTreeModelFilter();
}

void ResourceTreeView::setupTreeModelFilter()
void ResourceTreeView::SetupTreeModelFilter()
{
// Set up the filter
_treeModelFilter.reset(new TreeModelFilter(_treeStore));

_treeModelFilter->SetVisibleFunc([this](TreeModel::Row& row)
{
return treeModelFilterFunc(row);
return _treeModelFilterFunc(row);
});

AssociateModel(_treeModelFilter.get());
Expand Down Expand Up @@ -120,19 +120,19 @@ void ResourceTreeView::setupTreeModelFilter()
}
}

ResourceTreeView::TreeMode ResourceTreeView::getTreeMode() const
ResourceTreeView::TreeMode ResourceTreeView::GetTreeMode() const
{
return _mode;
}

void ResourceTreeView::setTreeMode(ResourceTreeView::TreeMode mode)
void ResourceTreeView::SetTreeMode(ResourceTreeView::TreeMode mode)
{
_mode = mode;

setupTreeModelFilter();
SetupTreeModelFilter();
}

void ResourceTreeView::populateContextMenu(wxutil::PopupMenu& popupMenu)
void ResourceTreeView::PopulateContextMenu(wxutil::PopupMenu& popupMenu)
{
if (popupMenu.GetMenuItemCount() > 0)
{
Expand All @@ -152,7 +152,7 @@ void ResourceTreeView::populateContextMenu(wxutil::PopupMenu& popupMenu)
);
}

std::string ResourceTreeView::getSelection()
std::string ResourceTreeView::GetSelectedFullname()
{
// Get the selected value
wxDataViewItem item = GetSelection();
Expand All @@ -168,25 +168,25 @@ std::string ResourceTreeView::getSelection()
return row[_columns.fullName];
}

void ResourceTreeView::setSelection(const std::string& fullName)
void ResourceTreeView::SetSelectedFullname(const std::string& fullName)
{
if (_populator)
{
// Postpone the selection, store the name
_itemToSelectAfterPopulation = fullName;
_fullNameToSelectAfterPopulation = fullName;
return;
}

// If the selection string is empty, collapse the treeview and return with
// no selection
if (fullName.empty())
{
Collapse(getTreeModel()->GetRoot());
Collapse(GetTreeModel()->GetRoot());
return;
}

// Find the requested element
auto item = getTreeModel()->FindString(fullName, _columns.fullName);
auto item = GetTreeModel()->FindString(fullName, _columns.fullName);

if (item.IsOk())
{
Expand All @@ -198,25 +198,25 @@ void ResourceTreeView::setSelection(const std::string& fullName)
ProcessWindowEvent(ev);
}

_itemToSelectAfterPopulation.clear();
_fullNameToSelectAfterPopulation.clear();
}

void ResourceTreeView::clear()
void ResourceTreeView::Clear()
{
// Clear any data and/or active population objects
_populator.reset();
_treeStore->Clear();
_emptyFavouritesLabel = wxDataViewItem();
_itemToSelectAfterPopulation.clear();
_fullNameToSelectAfterPopulation.clear();
}

void ResourceTreeView::populate(const IResourceTreePopulator::Ptr& populator)
void ResourceTreeView::Populate(const IResourceTreePopulator::Ptr& populator)
{
// Remove any data or running populators first
clear();
Clear();

// Add the loading icon to the tree
TreeModel::Row row = getTreeModel()->AddItem();
TreeModel::Row row = GetTreeModel()->AddItem();

row[_columns.iconAndName] = wxVariant(wxDataViewIconText(_("Loading resources...")));
row[_columns.isFavourite] = true;
Expand All @@ -232,15 +232,15 @@ void ResourceTreeView::populate(const IResourceTreePopulator::Ptr& populator)
_populator->Populate();
}

void ResourceTreeView::setExpandTopLevelItemsAfterPopulation(bool expand)
void ResourceTreeView::SetExpandTopLevelItemsAfterPopulation(bool expand)
{
_expandTopLevelItemsAfterPopulation = expand;
}

void ResourceTreeView::_onTreeStorePopulationFinished(TreeModel::PopulationFinishedEvent& ev)
{
UnselectAll();
setTreeModel(ev.GetTreeModel());
SetTreeModel(ev.GetTreeModel());
_populator.reset();

if (_expandTopLevelItemsAfterPopulation)
Expand All @@ -249,9 +249,9 @@ void ResourceTreeView::_onTreeStorePopulationFinished(TreeModel::PopulationFinis
}

// Populator is empty now, check if we need to pre-select anything
if (!_itemToSelectAfterPopulation.empty())
if (!_fullNameToSelectAfterPopulation.empty())
{
setSelection(_itemToSelectAfterPopulation);
SetSelectedFullname(_fullNameToSelectAfterPopulation);
}
}

Expand All @@ -261,7 +261,7 @@ void ResourceTreeView::_onContextMenu(wxDataViewEvent& ev)
{
_popupMenu.reset(new wxutil::PopupMenu());

populateContextMenu(*_popupMenu);
PopulateContextMenu(*_popupMenu);
}

_popupMenu->show(this);
Expand All @@ -270,16 +270,16 @@ void ResourceTreeView::_onContextMenu(wxDataViewEvent& ev)
bool ResourceTreeView::_testAddToFavourites()
{
// Adding favourites is allowed for any folder and non-favourite items
return isDirectorySelected() || (GetSelection().IsOk() && !isFavouriteSelected());
return IsDirectorySelected() || (GetSelection().IsOk() && !IsFavouriteSelected());
}

bool ResourceTreeView::_testRemoveFromFavourites()
{
// We can run remove from favourites on any folder or on favourites themselves
return isDirectorySelected() || isFavouriteSelected();
return IsDirectorySelected() || IsFavouriteSelected();
}

void ResourceTreeView::setFavouriteRecursively(TreeModel::Row& row, bool isFavourite)
void ResourceTreeView::SetFavouriteRecursively(TreeModel::Row& row, bool isFavourite)
{
if (row[_columns.isFolder].getBool())
{
Expand All @@ -290,7 +290,7 @@ void ResourceTreeView::setFavouriteRecursively(TreeModel::Row& row, bool isFavou
for (const wxDataViewItem& child : children)
{
TreeModel::Row childRow(child, *GetModel());
setFavouriteRecursively(childRow, isFavourite);
SetFavouriteRecursively(childRow, isFavourite);
}

return;
Expand Down Expand Up @@ -322,13 +322,13 @@ void ResourceTreeView::_onSetFavourite(bool isFavourite)
// Grab this item and enter recursion, propagating the favourite status
TreeModel::Row row(item, *GetModel());

setFavouriteRecursively(row, isFavourite);
SetFavouriteRecursively(row, isFavourite);

// Store to registry on each change
// TODO: ? _favourites->saveToRegistry();
}

bool ResourceTreeView::isDirectorySelected()
bool ResourceTreeView::IsDirectorySelected()
{
wxDataViewItem item = GetSelection();

Expand All @@ -339,7 +339,7 @@ bool ResourceTreeView::isDirectorySelected()
return row[_columns.isFolder].getBool();
}

bool ResourceTreeView::isFavouriteSelected()
bool ResourceTreeView::IsFavouriteSelected()
{
wxDataViewItem item = GetSelection();

Expand All @@ -350,7 +350,7 @@ bool ResourceTreeView::isFavouriteSelected()
return row[_columns.isFavourite].getBool();
}

bool ResourceTreeView::treeModelFilterFunc(wxutil::TreeModel::Row& row)
bool ResourceTreeView::_treeModelFilterFunc(wxutil::TreeModel::Row& row)
{
if (_mode == TreeMode::ShowAll) return true; // everything is visible

Expand All @@ -368,7 +368,7 @@ bool ResourceTreeView::treeModelFilterFunc(wxutil::TreeModel::Row& row)
{
wxutil::TreeModel::Row childRow(child, *_treeStore);

if (treeModelFilterFunc(childRow))
if (_treeModelFilterFunc(childRow))
{
return true;
}
Expand Down
32 changes: 16 additions & 16 deletions libs/wxutil/dataview/ResourceTreeView.h
View file
Expand Up @@ -68,7 +68,7 @@ class ResourceTreeView :
IResourceTreePopulator::Ptr _populator;

bool _expandTopLevelItemsAfterPopulation;
std::string _itemToSelectAfterPopulation;
std::string _fullNameToSelectAfterPopulation;

public:
ResourceTreeView(wxWindow* parent, const Columns& columns, long style = wxDV_SINGLE);
Expand All @@ -77,32 +77,32 @@ class ResourceTreeView :
virtual ~ResourceTreeView();

// Returns a reference to the model we're using
virtual const TreeModel::Ptr& getTreeModel();
virtual void setTreeModel(const TreeModel::Ptr& treeModel);
virtual const TreeModel::Ptr& GetTreeModel();
virtual void SetTreeModel(const TreeModel::Ptr& treeModel);

virtual TreeMode getTreeMode() const;
virtual void setTreeMode(TreeMode mode);
virtual TreeMode GetTreeMode() const;
virtual void SetTreeMode(TreeMode mode);

// Returns the full name of the selection (or an empty string)
virtual std::string getSelection();
virtual void setSelection(const std::string& fullName);
virtual std::string GetSelectedFullname();
virtual void SetSelectedFullname(const std::string& fullName);

virtual void clear();
virtual void Clear();

virtual bool isDirectorySelected();
virtual bool isFavouriteSelected();
virtual bool IsDirectorySelected();
virtual bool IsFavouriteSelected();

// Populate this tree using the given populator object
virtual void populate(const IResourceTreePopulator::Ptr& populator);
virtual void Populate(const IResourceTreePopulator::Ptr& populator);

void setExpandTopLevelItemsAfterPopulation(bool expand);
void SetExpandTopLevelItemsAfterPopulation(bool expand);

protected:
virtual void populateContextMenu(wxutil::PopupMenu& popupMenu);
virtual void PopulateContextMenu(wxutil::PopupMenu& popupMenu);

virtual void setFavouriteRecursively(TreeModel::Row& row, bool isFavourite);
virtual void SetFavouriteRecursively(TreeModel::Row& row, bool isFavourite);

virtual void setupTreeModelFilter();
virtual void SetupTreeModelFilter();

private:
void _onContextMenu(wxDataViewEvent& ev);
Expand All @@ -113,7 +113,7 @@ class ResourceTreeView :
void _onSetFavourite(bool isFavourite);

// Evaluation function for item visibility
bool treeModelFilterFunc(TreeModel::Row& row);
bool _treeModelFilterFunc(TreeModel::Row& row);
};

}
18 changes: 9 additions & 9 deletions radiant/ui/mediabrowser/MediaBrowser.cpp
View file
Expand Up @@ -73,8 +73,8 @@ void MediaBrowser::construct()
// Connect up the selection changed callback
_treeView->Bind(wxEVT_DATAVIEW_SELECTION_CHANGED, &MediaBrowser::_onTreeViewSelectionChanged, this);

_showAll->SetValue(_treeView->getTreeMode() == MediaBrowserTreeView::TreeMode::ShowAll);
_showFavourites->SetValue(_treeView->getTreeMode() == MediaBrowserTreeView::TreeMode::ShowFavourites);
_showAll->SetValue(_treeView->GetTreeMode() == MediaBrowserTreeView::TreeMode::ShowAll);
_showFavourites->SetValue(_treeView->GetTreeMode() == MediaBrowserTreeView::TreeMode::ShowFavourites);

_showAll->Bind(wxEVT_RADIOBUTTON, [&](wxCommandEvent& ev)
{
Expand Down Expand Up @@ -130,28 +130,28 @@ void MediaBrowser::onMainFrameConstructed()

std::string MediaBrowser::getSelection()
{
return _treeView->getSelection();
return _treeView->GetSelectedFullname();
}

// Set the selection in the treeview
void MediaBrowser::setSelection(const std::string& selection)
{
_treeView->setSelection(selection);
_treeView->SetSelectedFullname(selection);
}

void MediaBrowser::onMaterialDefsLoaded()
{
_treeView->populate();
_treeView->Populate();
}

void MediaBrowser::onMaterialDefsUnloaded()
{
_treeView->clear();
_treeView->Clear();
}

void MediaBrowser::setTreeModeFromControls()
{
_treeView->setTreeMode(_showAll->GetValue() ?
_treeView->SetTreeMode(_showAll->GetValue() ?
MediaBrowserTreeView::TreeMode::ShowAll :
MediaBrowserTreeView::TreeMode::ShowFavourites);
}
Expand All @@ -161,7 +161,7 @@ void MediaBrowser::_onTreeViewSelectionChanged(wxDataViewEvent& ev)
util::ScopedBoolLock lock(_blockShaderClipboardUpdates);

// Update the preview if a texture is selected
if (!_treeView->isDirectorySelected())
if (!_treeView->IsDirectorySelected())
{
_preview->SetTexture(getSelection());
GlobalShaderClipboard().setSourceShader(getSelection());
Expand Down Expand Up @@ -230,7 +230,7 @@ void MediaBrowser::initialiseModule(const IApplicationContext& ctx)
);

// Start loading materials
_treeView->populate();
_treeView->Populate();

_shaderClipboardConn = GlobalShaderClipboard().signal_sourceChanged().connect(
sigc::mem_fun(this, &MediaBrowser::onShaderClipboardSourceChanged)
Expand Down

0 comments on commit ebc5c97

Please sign in to comment.