Make method naming more consistent.

* Use id() for methods returning a string used to represent
    some type of object.
  * Use displayName() for strings that are meant to be user
    visible.
  * Quieten some warnings while touching the files anyway.
  * Move Factories to their products in the plugins where that
    was not done before.

Reviewed-by: dt
This commit is contained in:
Tobias Hunger
2010-01-07 18:17:24 +01:00
parent 8bb87fcda4
commit a6ad773722
332 changed files with 1666 additions and 1543 deletions

View File

@@ -48,7 +48,7 @@ QString DocSettingsPage::id() const
return QLatin1String("B.Documentation");
}
QString DocSettingsPage::trName() const
QString DocSettingsPage::displayName() const
{
return tr("Documentation");
}
@@ -58,7 +58,7 @@ QString DocSettingsPage::category() const
return QLatin1String(Help::Constants::HELP_CATEGORY);
}
QString DocSettingsPage::trCategory() const
QString DocSettingsPage::displayCategory() const
{
return QCoreApplication::translate("Help", Help::Constants::HELP_TR_CATEGORY);
}

View File

@@ -49,9 +49,9 @@ public:
DocSettingsPage(QHelpEngine *helpEngine);
QString id() const;
QString trName() const;
QString displayName() const;
QString category() const;
QString trCategory() const;
QString displayCategory() const;
QWidget *createPage(QWidget *parent);
void apply();

View File

@@ -49,7 +49,7 @@ QString FilterSettingsPage::id() const
return QLatin1String("D.Filters");
}
QString FilterSettingsPage::trName() const
QString FilterSettingsPage::displayName() const
{
return tr("Filters");
}
@@ -59,7 +59,7 @@ QString FilterSettingsPage::category() const
return QLatin1String(Help::Constants::HELP_CATEGORY);
}
QString FilterSettingsPage::trCategory() const
QString FilterSettingsPage::displayCategory() const
{
return QCoreApplication::translate("Help", Help::Constants::HELP_TR_CATEGORY);
}

View File

@@ -48,9 +48,9 @@ public:
FilterSettingsPage(QHelpEngine *helpEngine);
QString id() const;
QString trName() const;
QString displayName() const;
QString category() const;
QString trCategory() const;
QString displayCategory() const;
QWidget *createPage(QWidget *parent);
void apply();

View File

@@ -71,7 +71,7 @@ QString GeneralSettingsPage::id() const
return QLatin1String("A.General settings");
}
QString GeneralSettingsPage::trName() const
QString GeneralSettingsPage::displayName() const
{
return tr("General settings");
}
@@ -81,7 +81,7 @@ QString GeneralSettingsPage::category() const
return QLatin1String(Help::Constants::HELP_CATEGORY);
}
QString GeneralSettingsPage::trCategory() const
QString GeneralSettingsPage::displayCategory() const
{
return QCoreApplication::translate("Help", Help::Constants::HELP_TR_CATEGORY);
}

View File

@@ -56,9 +56,9 @@ public:
BookmarkManager *bookmarkManager);
QString id() const;
virtual QString trName() const;
virtual QString displayName() const;
QString category() const;
QString trCategory() const;
QString displayCategory() const;
QWidget *createPage(QWidget *parent);
void apply();

View File

@@ -67,12 +67,12 @@ void HelpIndexFilter::updateIndices()
m_plugin->setIndexFilter(currentFilter);
}
QString HelpIndexFilter::trName() const
QString HelpIndexFilter::displayName() const
{
return tr("Help index");
}
QString HelpIndexFilter::name() const
QString HelpIndexFilter::id() const
{
return QLatin1String("HelpIndexFilter");
}

View File

@@ -52,8 +52,8 @@ public:
HelpIndexFilter(HelpPlugin *plugin, QHelpEngine *helpEngine);
// ILocatorFilter
QString trName() const;
QString name() const;
QString displayName() const;
QString id() const;
Priority priority() const;
QList<Locator::FilterEntry> matchesFor(const QString &entry);
void accept(Locator::FilterEntry selection) const;

View File

@@ -43,8 +43,8 @@ using namespace Help::Internal;
HelpMode::HelpMode(QWidget *widget, QWidget *centralWidget, QObject *parent)
: BaseMode(parent), m_centralWidget(centralWidget)
{
setName(tr("Help"));
setUniqueModeName(Constants::ID_MODE_HELP);
setDisplayName(tr("Help"));
setId(QLatin1String(Constants::ID_MODE_HELP));
setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Reference.png")));
setPriority(Constants::P_MODE_HELP);
setWidget(widget);