Categories


Popular topics

(Add)
(Tools)
 
(20 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
What is a project? In UltraEdit, a project is a virtual "storage container" allowing you to group and manage associated files (for example, a development project you're working on) and your workspace for those files. Support for projects is tightly integrated throughout other areas in UltraEdit, such as [[Ctags]] for project files, [[Find in files]] in project files, [[Function list]]ing for project files, [[Intellitips]], and much more. You can add files and/or folders to a project.
 
What is a project? In UltraEdit, a project is a virtual "storage container" allowing you to group and manage associated files (for example, a development project you're working on) and your workspace for those files. Support for projects is tightly integrated throughout other areas in UltraEdit, such as [[Ctags]] for project files, [[Find in files]] in project files, [[Function list]]ing for project files, [[Intellitips]], and much more. You can add files and/or folders to a project.
  
Project support consists of the project itself (i.e., the files contained within it) and the workspace. The '''workspace''' consists of all files that should be '''opened''' when the project is loaded as well as the view state of project items in the project tree in the [[File view]]. The workspace functionality saves the state of all open files in the project file when the project is closed including window position, caret position, and which files are open. These are then reloaded the next time the project is reloaded. Files in the workspace do not have to be specifically added to the project.
+
Project support consists of the project itself (i.e., the files contained within it) and the workspace. The '''workspace''' consists of all files that should be '''opened''' when the project is loaded as well as the view state of project items in the Project pane in the [[File view]]. The workspace functionality saves the state of all open files in the project file when the project is closed including window position, caret position, and which files are open. These are then reloaded the next time the project is reloaded. Files in the workspace do not have to be specifically added to the project.
  
 
===Project===
 
===Project===
 
{|
 
{|
 
|Open
 
|Open
|opens an existing project file
+
|Allows you to open an existing project
 
|-
 
|-
 
|Recent
 
|Recent
|lists recently used projects
+
|Lists recently opened projects. Selecting one will open that project.
 
|-
 
|-
 
|New project
 
|New project
 
|Opens dialog to create and save a new project file (.prj). After you save the project file, the project is created and the [[Project settings]] dialog is immediately opened.  
 
|Opens dialog to create and save a new project file (.prj). After you save the project file, the project is created and the [[Project settings]] dialog is immediately opened.  
 +
|-
 +
|New project using templates
 +
|Opens [[project templates]] dialog to create and save a new project based upon a compilable project template.
 
|-
 
|-
 
|Close project
 
|Close project
|closes a project
+
|Closes the active project
 
|-
 
|-
 
|[[Project settings]]
 
|[[Project settings]]
|adds, removes, or opens files within the project; also allows you to configure other project settings
+
|Adds, removes, or opens files within the project; also allows you to configure other project settings
 
|}
 
|}
  
 
===Add===
 
===Add===
 
{|
 
{|
|[[Add to project]]
+
|Add to project - File...
|opens submenu to insert files/folders/groups into active project
+
|Opens file browser where you can choose files to be added to the active project.  If no group is selected in the "Project group" drop down, the selected file(s) will be added to the root of the project.
 +
|-
 +
|Add to project - Folder...
 +
|Opens [[New folder]] dialog for adding a folder from the file system to the project.
 +
|-
 +
|Add to project - Group...
 +
|Opens dialog allowing you to specify name of a new group (virtual) folder for the project. Group folders are not "real" folders but act as containers within the project.
 +
|-
 
|}
 
|}
  
Line 33: Line 43:
 
{|
 
{|
 
|Go to symbol definition
 
|Go to symbol definition
|displays [[IntelliTips]] list indicating where selected symbol is defined. Double-clicking item in list opens referenced file to definition point.
+
|Displays [[IntelliTips]] list indicating where selected symbol is defined. Double-clicking item in list opens referenced file to definition point.
 
|-
 
|-
 
|Display function tip
 
|Display function tip
|displays function tips defined in active file
+
|Displays function tip popup (parameters) for the function next to the caret. The caret must be positioned within the function call's braces in order to see the function tip.
 
|-
 
|-
 
|Reparse active file
 
|Reparse active file
|forces [[IntelliTips]] to reparse active file
+
|Forces [[IntelliTips]] to reparse active file.
 
|-
 
|-
 
|More [[IntelliTips]] - .source -> .header
 
|More [[IntelliTips]] - .source -> .header
|displays context menu allowing user to toggle between source and associated header file
+
|Displays context menu allowing you to toggle between source and associated header file.
 
|-
 
|-
 
|More [[IntelliTips]] - File list
 
|More [[IntelliTips]] - File list
|displays file list
+
|Displays list of source files that are determined to be related to the active file in terms of includes, header files, etc.
 
|-
 
|-
 
|More [[IntelliTips]] - Symbol list
 
|More [[IntelliTips]] - Symbol list
|displays available symbols for auto-completing word under caret (for example, an object member)
+
|Displays available symbols for auto-completing word under caret (for example, an object member).
 
|-
 
|-
 
|More [[IntelliTips]] - Keyword list
 
|More [[IntelliTips]] - Keyword list
|displays all available keywords / templates for current source file
+
|Displays all available keywords / templates for current file's source code language.
 
|-
 
|-
 
|More [[IntelliTips]] - Show functions in this file
 
|More [[IntelliTips]] - Show functions in this file
|displays functions defined in active file
+
|Displays functions defined in active file.
 
|-
 
|-
 
|More [[IntelliTips]] - Jump to [[Classviewer]]
 
|More [[IntelliTips]] - Jump to [[Classviewer]]
|toggles Workspace Manager to display Tags pane
+
|Toggles [[File view|Workspace Manager]] and activates Tags pane / Classviewer.
 
|}
 
|}
  
Line 63: Line 73:
 
{|
 
{|
 
|Find symbol
 
|Find symbol
|finds symbol in tag file
+
|Jumps to definition of symbol (class, function, variable) under caret (based upon [[Ctags]])
 
|-
 
|-
 
|[[Ctags|Generate tags]]
 
|[[Ctags|Generate tags]]
|creates tag file
+
|Creates [[Ctags]] tag file from either active project or active file
 
|-
 
|-
|[[Ctags|CTag options]]
+
|[[Ctags|Ctag options]]
|sets up options for Ctags
+
|Opens dialog allowing you to set options for [[Ctags]]
 
|}
 
|}
  
Line 75: Line 85:
 
{|
 
{|
 
|[[Backup project]]
 
|[[Backup project]]
|copies all active files in the current project/workspace to a compressed backup file (.bup) stored in the same directory as the .prj file for the active project/workspace
+
|Copies all active files in the current project/workspace to a compressed backup file (.bup) stored in the same directory as the .prj file for the active project/workspace
 
|-
 
|-
 
|[[Restore project]]
 
|[[Restore project]]
|presents Restore Project Files dialog to reload a project from a copy that was previously backed up
+
|Opens "Restore project files" dialog to reload a project from a copy that was previously backed up
 
|}
 
|}
  
 
===Tools===
 
===Tools===
 
{|
 
{|
|[[User tools|Tool configuration]]
+
|[[Configure tools|Tool configuration]]
|presents dialog for user-definable tool configuration for active project
+
|Opens dialog for user-definable tool configuration for active project
 +
|-
 +
|Project tool #
 +
|Selecting a project tool in the drop down list will run that tool.
 
|}
 
|}
  
Line 92: Line 105:
 
{|
 
{|
 
|[[Git]] - Add current file
 
|[[Git]] - Add current file
|adds current file to active Git repository
+
|Adds current file to active Git repository.
 
|-
 
|-
 
|[[Git]] - Commit current file
 
|[[Git]] - Commit current file
|records changes to current file to repository
+
|Records changes to current file to repository.
 
|-
 
|-
 
|[[Git]] - Commit all files
 
|[[Git]] - Commit all files
|records changes for all files to repository
+
|Records changes for all files to repository.
 
|-
 
|-
 
|[[Git]] - Stash changes
 
|[[Git]] - Stash changes
|stashes changes in working directory
+
|Stashes uncommitted changes in active repository.
 
|-
 
|-
 
|[[Git]] - Blame (current file)
 
|[[Git]] - Blame (current file)
|shows what revision and author last modified each line of a file
+
|Shows what revision and author last modified each line of the active file.
 
|-
 
|-
 
|[[Git]] - Pull
 
|[[Git]] - Pull
|incorporates changes from a remote repository into the current branch
+
|Incorporates changes from a remote repository into the current branch.
 
|-
 
|-
 
|[[Git]] - Push
 
|[[Git]] - Push
|updates a remote repository with changes from a local repository
+
|Updates a remote repository with changes from a local repository.
 
|-
 
|-
 
|[[Git]] - Show git branch
 
|[[Git]] - Show git branch
|toggles visibility of [[Git branch manager]]
+
|Toggles visibility of Git [[branch manager]].
 
|-
 
|-
 
|[[Git]] - Show git shell
 
|[[Git]] - Show git shell
|toggles visibility of [[Git shell]]
+
|Toggles visibility of [[Git shell]].
 
|-
 
|-
 
|CVS/Subversion - Active module
 
|CVS/Subversion - Active module
|opens [[Version control module manager]]
+
|Opens [[Version control module manager]].
 
|-
 
|-
 
|[[CVS/Subversion - Checkout]]
 
|[[CVS/Subversion - Checkout]]
|checks out module from repository
+
|Checks out module from repository.
 
|-
 
|-
 
|CVS/Subversion - Tag
 
|CVS/Subversion - Tag
|creates tag (branch) in CVS tree
+
|Creates tag (branch) in CVS / Subversion repository.
 
|-
 
|-
 
|[[CVS/Subversion - Import]]
 
|[[CVS/Subversion - Import]]
|imports new module into repository
+
|Imports new module into repository.
 
|-
 
|-
 
|[[CVS/Subversion - Export]]
 
|[[CVS/Subversion - Export]]
|checks out module excluding CVS information
+
|Exports module excluding CVS / Subversion repository information and files.
 
|-
 
|-
 
|[[CVS/Subversion - Accounts/settings]]
 
|[[CVS/Subversion - Accounts/settings]]
|launches CVS Manager dialog
+
|Launches version control accounts manager dialog.
 
|-
 
|-
|[[Update]]
+
|Update
|commits working copy from repository without displaying any prompts or options
+
|Updates working copy from repository without displaying any prompts or options.
 +
|-
 +
|Update - Update (special)
 +
|Opens either the [[CVS update]] or [[Subversion update]] dialog, depending on which version control system you're using, with options for the update.
 
|-
 
|-
 
|[[Commit]]
 
|[[Commit]]
|commits working copy to repository without displaying any prompts or options
+
|Commits all local changes to repository without displaying any prompts or options.
 
|}
 
|}
  
Line 147: Line 163:
  
 
{|
 
{|
 +
|[[Project converter]]
 +
|Opens Project Converter where you can convert existing Visual Studio projects to UEStudio projects.
 +
|-
 
|[[Project manager]]
 
|[[Project manager]]
|launches Project Manager dialog from which users may open, create, backup, restore or batch build projects
+
|Opens Project Manager dialog from which users may open, create, backup, restore or batch build projects.
 
|-
 
|-
 
|[[Solution]] - New
 
|[[Solution]] - New
|presents dialog for creation of a new solution (.prw)
+
|Allows you to create a new [[solution]] by choosing the location and name to save the solution (.prw) file.
 
|-
 
|-
 
|[[Solution]] - Open
 
|[[Solution]] - Open
|presents dialog for selection of an existing solution to be opened
+
|Allows you to browse to and open an existing solution.
 
|-
 
|-
 
|[[Solution]] - Close
 
|[[Solution]] - Close
|closes the currently active solution
+
|Closes the active solution.
 
|-
 
|-
|[[Add projects]]
+
|Add projects
|presents a dialog to allow users to browse to a project and add it to the active solution
+
|Allows you to browse to a project and add it to the active solution. If a project is opened in a solution, this project is set in the solution (INI based) file as active, so that the next time the solution is opened, this project is opened also. 
 
|-
 
|-
|[[Remove projects]]
+
|Remove projects
|removes the current project from the active solution
+
|Opens the "Projects in Solution" dialog, where you can choose which project(s) to remove from the active solution.
 
|}
 
|}

Latest revision as of 22:08, 1 February 2018

What is a project? In UltraEdit, a project is a virtual "storage container" allowing you to group and manage associated files (for example, a development project you're working on) and your workspace for those files. Support for projects is tightly integrated throughout other areas in UltraEdit, such as Ctags for project files, Find in files in project files, Function listing for project files, Intellitips, and much more. You can add files and/or folders to a project.

Project support consists of the project itself (i.e., the files contained within it) and the workspace. The workspace consists of all files that should be opened when the project is loaded as well as the view state of project items in the Project pane in the File view. The workspace functionality saves the state of all open files in the project file when the project is closed including window position, caret position, and which files are open. These are then reloaded the next time the project is reloaded. Files in the workspace do not have to be specifically added to the project.

Project

Open Allows you to open an existing project
Recent Lists recently opened projects. Selecting one will open that project.
New project Opens dialog to create and save a new project file (.prj). After you save the project file, the project is created and the Project settings dialog is immediately opened.
New project using templates Opens project templates dialog to create and save a new project based upon a compilable project template.
Close project Closes the active project
Project settings Adds, removes, or opens files within the project; also allows you to configure other project settings

Add

Add to project - File... Opens file browser where you can choose files to be added to the active project. If no group is selected in the "Project group" drop down, the selected file(s) will be added to the root of the project.
Add to project - Folder... Opens New folder dialog for adding a folder from the file system to the project.
Add to project - Group... Opens dialog allowing you to specify name of a new group (virtual) folder for the project. Group folders are not "real" folders but act as containers within the project.

IntelliTips

The following IntelliTips functionality is available in UEStudio only

Go to symbol definition Displays IntelliTips list indicating where selected symbol is defined. Double-clicking item in list opens referenced file to definition point.
Display function tip Displays function tip popup (parameters) for the function next to the caret. The caret must be positioned within the function call's braces in order to see the function tip.
Reparse active file Forces IntelliTips to reparse active file.
More IntelliTips - .source -> .header Displays context menu allowing you to toggle between source and associated header file.
More IntelliTips - File list Displays list of source files that are determined to be related to the active file in terms of includes, header files, etc.
More IntelliTips - Symbol list Displays available symbols for auto-completing word under caret (for example, an object member).
More IntelliTips - Keyword list Displays all available keywords / templates for current file's source code language.
More IntelliTips - Show functions in this file Displays functions defined in active file.
More IntelliTips - Jump to Classviewer Toggles Workspace Manager and activates Tags pane / Classviewer.

Tags

Find symbol Jumps to definition of symbol (class, function, variable) under caret (based upon Ctags)
Generate tags Creates Ctags tag file from either active project or active file
Ctag options Opens dialog allowing you to set options for Ctags

Backup

Backup project Copies all active files in the current project/workspace to a compressed backup file (.bup) stored in the same directory as the .prj file for the active project/workspace
Restore project Opens "Restore project files" dialog to reload a project from a copy that was previously backed up

Tools

Tool configuration Opens dialog for user-definable tool configuration for active project
Project tool # Selecting a project tool in the drop down list will run that tool.

Version control

The following version control functionality is available in UEStudio only

Git - Add current file Adds current file to active Git repository.
Git - Commit current file Records changes to current file to repository.
Git - Commit all files Records changes for all files to repository.
Git - Stash changes Stashes uncommitted changes in active repository.
Git - Blame (current file) Shows what revision and author last modified each line of the active file.
Git - Pull Incorporates changes from a remote repository into the current branch.
Git - Push Updates a remote repository with changes from a local repository.
Git - Show git branch Toggles visibility of Git branch manager.
Git - Show git shell Toggles visibility of Git shell.
CVS/Subversion - Active module Opens Version control module manager.
CVS/Subversion - Checkout Checks out module from repository.
CVS/Subversion - Tag Creates tag (branch) in CVS / Subversion repository.
CVS/Subversion - Import Imports new module into repository.
CVS/Subversion - Export Exports module excluding CVS / Subversion repository information and files.
CVS/Subversion - Accounts/settings Launches version control accounts manager dialog.
Update Updates working copy from repository without displaying any prompts or options.
Update - Update (special) Opens either the CVS update or Subversion update dialog, depending on which version control system you're using, with options for the update.
Commit Commits all local changes to repository without displaying any prompts or options.

Advanced

The following advanced project functionality is available in UEStudio only

Project converter Opens Project Converter where you can convert existing Visual Studio projects to UEStudio projects.
Project manager Opens Project Manager dialog from which users may open, create, backup, restore or batch build projects.
Solution - New Allows you to create a new solution by choosing the location and name to save the solution (.prw) file.
Solution - Open Allows you to browse to and open an existing solution.
Solution - Close Closes the active solution.
Add projects Allows you to browse to a project and add it to the active solution. If a project is opened in a solution, this project is set in the solution (INI based) file as active, so that the next time the solution is opened, this project is opened also.
Remove projects Opens the "Projects in Solution" dialog, where you can choose which project(s) to remove from the active solution.