src/WixToolset.Extensibility/ILayoutExtension.cs


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

// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.

namespace WixToolset.Extensibility
{
    using WixToolset.Extensibility.Data;

    /// <summary>
    /// Interface all layout extensions implement.
    /// </summary>
    public interface ILayoutExtension
    {
        /// <summary>
        /// Called before layout occurs.
        /// </summary>
        void PreLayout(ILayoutContext context);

#pragma warning disable 1591 // TODO: add documentation
        bool CopyFile(string source, string destination);

        bool MoveFile(string source, string destination);
#pragma warning restore 1591

        /// <summary>
        /// Called after all layout occurs.
        /// </summary>
        void PostLayout();
    }
}