Interface ICProjectDescription

    • Method Detail

      • setActiveConfiguration

        void setActiveConfiguration​(ICConfigurationDescription cfg)
                             throws WriteAccessException
        sets active configuration for this project description
        Parameters:
        cfg -
        Throws:
        WriteAccessException - when the project description is read-only the description is read only if it was queried/returned by the CoreModel.getProjectDescription(org.eclipse.core.resources.IProject, false) call
      • createConfiguration

        ICConfigurationDescription createConfiguration​(String id,
                                                       String name,
                                                       ICConfigurationDescription base)
                                                throws org.eclipse.core.runtime.CoreException,
                                                       WriteAccessException
        creates/adds a new configuration for this project description
        Parameters:
        id - configuration id
        name - configuration name
        base - the configuration description from which the settings are to be copied
        Returns:
        ICConfigurationDescription created
        Throws:
        org.eclipse.core.runtime.CoreException
        WriteAccessException - when the project description is read-only the description is read only if it was queried/returned by the CoreModel#getProjectDescription(org.eclipse.core.resources.IProject, false) call
      • createConfiguration

        ICConfigurationDescription createConfiguration​(String buildSystemId,
                                                       CConfigurationData data)
                                                throws org.eclipse.core.runtime.CoreException,
                                                       WriteAccessException
        creates/adds a new configuration for this project description This method is typically used by the Build System-specific code for creating new configurations
        Parameters:
        buildSystemId - build system id, i.e. the extension id contributing to the org.eclipse.cdt.core.CConfigurationDataProvider extension point
        data - CConfigurationData to be associated with this configuration
        Returns:
        ICConfigurationDescription created
        Throws:
        org.eclipse.core.runtime.CoreException
        WriteAccessException - when the project description is read-only the description is read only if it was queried/returned by the CoreModel.getProjectDescription(org.eclipse.core.resources.IProject, false) call
      • removeConfiguration

        void removeConfiguration​(String name)
                          throws WriteAccessException
        Remove Configuration of the given name from the project description
        Parameters:
        name - String name of the configuration to remove
        Throws:
        WriteAccessException - when the project description is read-only the description is read only if it was queried/returned by the CoreModel.getProjectDescription(org.eclipse.core.resources.IProject, false) call
      • getProject

        org.eclipse.core.resources.IProject getProject()
        Returns:
        IProject this project description is associated with
      • isModified

        boolean isModified()
        Description copied from interface: ICSettingsStorage
        Returns whether any non-persisted changes exist in this tree
        Specified by:
        isModified in interface ICSettingsStorage
        Returns:
        true if the project description was modified, false otherwise
      • getSessionProperty

        Object getSessionProperty​(org.eclipse.core.runtime.QualifiedName name)
        the get/setSettionsProperty methods allow to associate the session properties with the given project description session properties are not persisted and are not restored on the next eclipse session the scope of project description session properties is the current project description, i.e. modifications to the properties are not applied until the setProjectDescription call
        Parameters:
        name -
      • setSessionProperty

        void setSessionProperty​(org.eclipse.core.runtime.QualifiedName name,
                                Object value)
        the get/setSettionsProperty methods allow to associate the session properties with the given project description session properties are not persisted and are not restored on the next eclipse session the scope of project description session properties is the current project description, i.e. modifications to the properties are not applied until the setProjectDescription call
        Parameters:
        name -
        value -
      • setDefaultSettingConfiguration

        void setDefaultSettingConfiguration​(ICConfigurationDescription cfg)
        Sets the default setting ICConfigurationDescription. This is the configuration used by the CDT editor and views.
        Parameters:
        cfg -