feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Make method naming more consistent.

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

8
src/plugins/qmlprojectmanager/qmlnewprojectwizard.cpp
View File

@@ -59,11 +59,11 @@ Core::BaseFileWizardParameters QmlNewProjectWizard::parameters()
{
static Core::BaseFileWizardParameters parameters(ProjectWizard);
parameters.setIcon(QIcon(QLatin1String(":/wizards/images/console.png")));
parameters.setName(tr("QML Application"));
parameters.setDisplayName(tr("QML Application"));
parameters.setId(QLatin1String("QA.QML Application"));
parameters.setDescription(tr("Creates a QML application."));
parameters.setCategory(QLatin1String(ProjectExplorer::Constants::PROJECT_WIZARD_CATEGORY));
parameters.setTrCategory(QCoreApplication::translate("ProjectExplorer", ProjectExplorer::Constants::PROJECT_WIZARD_TR_CATEGORY));
parameters.setDisplayCategory(QCoreApplication::translate("ProjectExplorer", ProjectExplorer::Constants::PROJECT_WIZARD_TR_CATEGORY));
return parameters;
}
@@ -74,7 +74,7 @@ QWizard *QmlNewProjectWizard::createWizardDialog(QWidget *parent,
QmlNewProjectWizardDialog *wizard = new QmlNewProjectWizardDialog(parent);
wizard->setPath(defaultPath);
wizard->setName(QmlNewProjectWizardDialog::projectName(defaultPath));
wizard->setProjectName(QmlNewProjectWizardDialog::uniqueProjectName(defaultPath));
foreach (QWizardPage *p, extensionPages)
wizard->addPage(p);
@@ -88,7 +88,7 @@ Core::GeneratedFiles QmlNewProjectWizard::generateFiles(const QWizard *w,
Q_UNUSED(errorMessage)
const QmlNewProjectWizardDialog *wizard = qobject_cast<const QmlNewProjectWizardDialog *>(w);
const QString projectName = wizard->name();
const QString projectName = wizard->projectName();
const QString projectPath = wizard->path() + QLatin1Char('/') + projectName;
const QString creatorFileName = Core::BaseFileWizard::buildFileName(projectPath,

22
src/plugins/qmlprojectmanager/qmlproject.cpp
View File

@@ -166,7 +166,7 @@ QStringList QmlProject::convertToAbsoluteFiles(const QStringList &paths) const
QStringList QmlProject::files() const
{ return m_files; }
QString QmlProject::name() const
QString QmlProject::displayName() const
{
return m_projectName;
}
@@ -305,10 +305,9 @@ void QmlProjectFile::modified(ReloadBehavior *)
QmlRunConfiguration::QmlRunConfiguration(QmlProject *pro)
: ProjectExplorer::RunConfiguration(pro),
m_project(pro),
m_type(Constants::QMLRUNCONFIGURATION),
m_debugServerPort(3768)
{
setName(tr("QML Viewer"));
setDisplayName(tr("QML Viewer"));
// append creator/bin dir to search path (only useful for special creator-qml package)
const QString searchPath = QString(qgetenv("PATH"))
@@ -322,9 +321,9 @@ QmlRunConfiguration::~QmlRunConfiguration()
{
}
QString QmlRunConfiguration::type() const
QString QmlRunConfiguration::id() const
{
return m_type;
return QLatin1String(Constants::QMLRUNCONFIGURATION);
}
QString QmlRunConfiguration::viewerPath() const
@@ -476,7 +475,6 @@ void QmlRunConfiguration::restore(const ProjectExplorer::PersistentSettingsReade
}
QmlRunConfigurationFactory::QmlRunConfigurationFactory()
: m_type(Constants::QMLRUNCONFIGURATION)
{
}
@@ -484,22 +482,22 @@ QmlRunConfigurationFactory::~QmlRunConfigurationFactory()
{
}
bool QmlRunConfigurationFactory::canRestore(const QString &type) const
bool QmlRunConfigurationFactory::canRestore(const QString &id) const
{
if (type.startsWith(m_type))
if (id.startsWith(QLatin1String(Constants::QMLRUNCONFIGURATION)))
return true;
return false;
}
QStringList QmlRunConfigurationFactory::availableCreationTypes(ProjectExplorer::Project *) const
QStringList QmlRunConfigurationFactory::availableCreationIds(ProjectExplorer::Project *) const
{
return QStringList();
}
QString QmlRunConfigurationFactory::displayNameForType(const QString &type) const
QString QmlRunConfigurationFactory::displayNameForId(const QString &id) const
{
return type;
return id;
}
ProjectExplorer::RunConfiguration *QmlRunConfigurationFactory::create(ProjectExplorer::Project *project,
@@ -592,7 +590,7 @@ QmlRunControlFactory::~QmlRunControlFactory()
bool QmlRunControlFactory::canRun(RunConfiguration *runConfiguration, const QString &mode) const
{
Q_UNUSED(mode)
Q_UNUSED(mode);
return (qobject_cast<QmlRunConfiguration*>(runConfiguration) != 0);
}

16
src/plugins/qmlprojectmanager/qmlproject.h
View File

@@ -61,7 +61,7 @@ public:
QString filesFileName() const;
virtual QString name() const;
virtual QString displayName() const;
virtual Core::IFile *file() const;
virtual Manager *projectManager() const;
virtual ProjectExplorer::IBuildConfigurationFactory *buildConfigurationFactory() const;
@@ -149,7 +149,7 @@ public:
uint debugServerPort() const;
// RunConfiguration
virtual QString type() const;
virtual QString id() const;
virtual QWidget *configurationWidget();
virtual void save(ProjectExplorer::PersistentSettingsWriter &writer) const;
@@ -168,7 +168,6 @@ private:
QString m_qmlViewerCustomPath;
QString m_qmlViewerDefaultPath;
QString m_qmlViewerArgs;
QLatin1String m_type;
uint m_debugServerPort;
};
@@ -181,19 +180,16 @@ public:
virtual ~QmlRunConfigurationFactory();
// used to recreate the runConfigurations when restoring settings
virtual bool canRestore(const QString &type) const;
virtual bool canRestore(const QString &id) const;
// used to show the list of possible additons to a project, returns a list of types
virtual QStringList availableCreationTypes(ProjectExplorer::Project *pro) const;
virtual QStringList availableCreationIds(ProjectExplorer::Project *pro) const;
// used to translate the types to names to display to the user
virtual QString displayNameForType(const QString &type) const;
virtual QString displayNameForId(const QString &id) const;
virtual ProjectExplorer::RunConfiguration *create(ProjectExplorer::Project *project,
const QString &type);
private:
QLatin1String m_type;
const QString &id);
};
class QmlRunControl : public ProjectExplorer::RunControl {

3
src/plugins/qmlprojectmanager/qmlprojectconstants.h
View File

@@ -46,7 +46,8 @@ const char *const C_FILESEDITOR = ".files Editor";
// kinds
const char *const PROJECT_KIND = "QML";
const char *const FILES_EDITOR = ".qmlproject Editor";
const char *const FILES_EDITOR_ID = "Qt4.QmlProjectEditor";
const char *const FILES_EDITOR_DISPLAY_NAME = QT_TRANSLATE_NOOP("OpenWith::Editors", ".qmlproject Editor");
const char *const FILES_MIMETYPE = QMLMIMETYPE;
const char *const TASK_CATEGORY_QML = "Task.Category.Qml";

17
src/plugins/qmlprojectmanager/qmlprojectfileseditor.cpp
View File

@@ -75,16 +75,21 @@ QStringList ProjectFilesFactory::mimeTypes() const
return m_mimeTypes;
}
QString ProjectFilesFactory::kind() const
QString ProjectFilesFactory::id() const
{
return QLatin1String(Constants::FILES_EDITOR);
return QLatin1String(Constants::FILES_EDITOR_ID);
}
QString ProjectFilesFactory::displayName() const
{
return tr(Constants::FILES_EDITOR_DISPLAY_NAME);
}
Core::IFile *ProjectFilesFactory::open(const QString &fileName)
{
Core::EditorManager *editorManager = Core::EditorManager::instance();
if (Core::IEditor *editor = editorManager->openEditor(fileName, kind()))
if (Core::IEditor *editor = editorManager->openEditor(fileName, id()))
return editor->file();
return 0;
@@ -99,6 +104,8 @@ ProjectFilesEditable::ProjectFilesEditable(ProjectFilesEditor *editor)
{
Core::UniqueIDManager *uidm = Core::UniqueIDManager::instance();
m_context << uidm->uniqueIdentifier(Constants::C_FILESEDITOR);
setDisplayName(tr(Constants::FILES_EDITOR_DISPLAY_NAME));
}
ProjectFilesEditable::~ProjectFilesEditable()
@@ -109,9 +116,9 @@ QList<int> ProjectFilesEditable::context() const
return m_context;
}
const char *ProjectFilesEditable::kind() const
QString ProjectFilesEditable::id() const
{
return Constants::FILES_EDITOR;
return Constants::FILES_EDITOR_ID;
}
bool ProjectFilesEditable::duplicateSupported() const

5
src/plugins/qmlprojectmanager/qmlprojectfileseditor.h
View File

@@ -57,7 +57,8 @@ public:
virtual Core::IEditor *createEditor(QWidget *parent);
virtual QStringList mimeTypes() const;
virtual QString kind() const;
virtual QString id() const;
virtual QString displayName() const;
virtual Core::IFile *open(const QString &fileName);
private:
@@ -75,7 +76,7 @@ public:
virtual ~ProjectFilesEditable();
virtual QList<int> context() const;
virtual const char *kind() const;
virtual QString id() const;
virtual bool duplicateSupported() const;
virtual Core::IEditor *duplicate(QWidget *parent);

8
src/plugins/qmlprojectmanager/qmlprojectwizard.cpp
View File

@@ -56,7 +56,7 @@ QmlProjectWizardDialog::QmlProjectWizardDialog(QWidget *parent)
// first page
m_firstPage = new FileWizardPage;
m_firstPage->setTitle(tr("QML Project"));
m_firstPage->setNameLabel(tr("Project name:"));
m_firstPage->setFileNameLabel(tr("Project name:"));
m_firstPage->setPathLabel(tr("Location:"));
addPage(m_firstPage);
@@ -77,7 +77,7 @@ void QmlProjectWizardDialog::setPath(const QString &path)
QString QmlProjectWizardDialog::projectName() const
{
return m_firstPage->name();
return m_firstPage->fileName();
}
QmlProjectWizard::QmlProjectWizard()
@@ -91,11 +91,11 @@ Core::BaseFileWizardParameters QmlProjectWizard::parameters()
{
static Core::BaseFileWizardParameters parameters(ProjectWizard);
parameters.setIcon(QIcon(QLatin1String(":/wizards/images/console.png")));
parameters.setName(tr("Import of existing QML directory"));
parameters.setDisplayName(tr("Import of existing QML directory"));
parameters.setId(QLatin1String("QI.QML Import"));
parameters.setDescription(tr("Creates a QML project from an existing directory of QML files."));
parameters.setCategory(QLatin1String(ProjectExplorer::Constants::PROJECT_WIZARD_CATEGORY));
parameters.setTrCategory(QCoreApplication::translate("ProjectExplorer", ProjectExplorer::Constants::PROJECT_WIZARD_TR_CATEGORY));
parameters.setDisplayCategory(QCoreApplication::translate("ProjectExplorer", ProjectExplorer::Constants::PROJECT_WIZARD_TR_CATEGORY));
return parameters;
}