aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qtcreator/src/howto/creator-sessions.qdoc
blob: 63ac5a7a9381f30efe39d11bf3771247c034edad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************

/*!
    \page creator-project-managing-sessions.html
    \if defined(qtdesignstudio)
    \previouspage creator-project-managing-workspaces.html
    \nextpage creator-keyboard-shortcuts.html
    \else
    \previouspage creator-sharing-project-settings.html
    \nextpage creator-design-mode.html
    \endif

    \title Managing Sessions

    When you exit \QC, a snapshot of your current workspace is stored as a
    \e session. To restore the session automatically when you start \QC,
    select \uicontrol File > \uicontrol Sessions > \uicontrol Manage >
    \uicontrol {Restore last session on startup}.

    When you open or create any of the following items, they automatically
    become a part of the session:

    \list

        \li Projects
            \if defined(qtcreator)
            with their dependencies (including SUBDIRS projects when using
            qmake)
            \endif

        \li Editors

        \li Breakpoints and expressions

        \li Bookmarks

    \endlist

    A session is personal, that is, not meant to be shared. It is not supposed
    to reflect the project structure. It contains personal data, such as
    bookmarks and breakpoints that are usually not of interest to other
    developers working on the same projects.

    For example, if you work on a project and need to switch to another project
    for a while, you can clone the current session to save it under a name and
    create a new session for the other project. Everything that you open after
    switching to the new session becomes a part of it. When you want to return
    to working on the first project, switch to the saved session. \QC opens the
    projects and files that belong to the session.

    To manage sessions, select \uicontrol File > \uicontrol Sessions > \uicontrol Manage.

    \image qtcreator-session-manager.png

    To save a session under a new name, select \uicontrol Clone.

    To create a new session:

    \list 1

        \li Select \uicontrol New.

         \li In the \uicontrol {Enter the name of the session} field, enter a
             name for the session.

        \li Select \uicontrol Create to create a new empty session or
            \uicontrol {Create and Open} to create a session and to switch to
            it.

    \endlist

    To switch between sessions, select \uicontrol {Switch To}.

    \if defined(qtcreator)
    When you launch \QC, a list of existing sessions is displayed in the
    \uicontrol Welcome mode. To open a session, select it or press
    \key Ctrl+Alt+<number>, where \e <number> is the number of the session to
    open (available for the first nine sessions).

    \image qtcreator-welcome-session.png

    You can also use the \c t locator filter to open a session. For more
    information, see \l{Searching with the Locator}.

    To view more information about a session, select the down arrow icon that
    appears when you move the mouse cursor over the session name. Select actions
    to clone, rename, and delete sessions.

    When you start \QC from the command line, you can give the name of
    a session as argument and \QC will start with this session.

    For more information, see \l{Using Command Line Options}.
    \endif

*/