PDG_SortOptions.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * COMMENTS:
 */

#ifndef __PDG_SORT_OPTIONS_H__
#define __PDG_SORT_OPTIONS_H__

#include "PDG_API.h"
#include "PDG_Types.h"

#include <UT/UT_StringHolder.h>

/*
 * Configuration options for sorting work items
 */
struct PDG_API PDG_SortOptions
{
    /// Default sort options
    PDG_SortOptions()
        : myAttribute("")
        , myOrder(PDG_WorkItemSortOrder::eSortIndex)
        , myDirection(false)
        , myRequired(false)
    {
    }

    /// The sort attribute, used when the sort order is SortAttribute
    UT_StringHolder             myAttribute;

    /// The type of sort to use for work items
    PDG_WorkItemSortOrder       myOrder;

    /// Sort ascending or descending
    bool                        myDirection;

    /// Sort required items to the beginning of the list
    bool                        myRequired;
};

#endif