/*
 * java-gnome, a UI library for writing GTK and GNOME programs from Java!
 *
 * Copyright © 2010 Operational Dynamics Consulting, Pty Ltd and Others
 *
 * The code in this file, and the program it is a part of, is made available
 * to you by its authors as open source software: you can redistribute it
 * and/or modify it under the terms of the GNU General Public License version
 * 2 ("GPL") as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GPL for more details.
 *
 * You should have received a copy of the GPL along with this program. If not,
 * see http://www.gnu.org/licenses/. The authors of this program may be
 * contacted through http://java-gnome.sourceforge.net/.
 *
 * Linking this library statically or dynamically with other modules is making
 * a combined work based on this library. Thus, the terms and conditions of
 * the GPL cover the whole combination. As a special exception (the
 * "Classpath Exception"), the copyright holders of this library give you
 * permission to link this library with independent modules to produce an
 * executable, regardless of the license terms of these independent modules,
 * and to copy and distribute the resulting executable under terms of your
 * choice, provided that you also meet, for each linked independent module,
 * the terms and conditions of the license of that module. An independent
 * module is a module which is not derived from or based on this library. If
 * you modify this library, you may extend the Classpath Exception to your
 * version of the library, but you are not obligated to do so. If you do not
 * wish to do so, delete this exception statement from your version.
 */
package org.gnome.glib;

import org.freedesktop.bindings.Constant;

/**
 * Used to indicate the types of "special" user directory (as defined by the
 * XDG standard) that you can query with
 * {@link Glib#getUserSpecialDir(UserDirectory) Glib.getUserSpecialDir()}.
 * 
 * @author Serkan Kaba
 * @since 4.0.15
 */
public class UserDirectory extends Constant
{
    protected UserDirectory(int ordinal, String nickname) {
        super(ordinal, nickname);
    }

    /**
     * Represents Desktop directory of the user.
     */
    public static final UserDirectory DESKTOP = new UserDirectory(GlibUserDirectory.DIRECTORY_DESKTOP,
            "DESKTOP");

    /**
     * Represents Documents directory of the user.
     */
    public static final UserDirectory DOCUMENTS = new UserDirectory(
            GlibUserDirectory.DIRECTORY_DOCUMENTS, "DOCUMENTS");

    /**
     * Represents Download directory of the user.
     */
    public static final UserDirectory DOWNLOAD = new UserDirectory(GlibUserDirectory.DIRECTORY_DOWNLOAD,
            "DOWNLOAD");

    /**
     * Represents Music directory of the user.
     */
    public static final UserDirectory MUSIC = new UserDirectory(GlibUserDirectory.DIRECTORY_MUSIC,
            "MUSIC");

    /**
     * Represents Pictures directory of the user.
     */
    public static final UserDirectory PICTURES = new UserDirectory(GlibUserDirectory.DIRECTORY_PICTURES,
            "PICTURES");

    /**
     * Represents Public directory of the user.
     */
    public static final UserDirectory PUBLIC_SHARE = new UserDirectory(
            GlibUserDirectory.DIRECTORY_PUBLIC_SHARE, "PUBLIC_SHARE");

    /**
     * Represents Templates directory of the user.
     */
    public static final UserDirectory TEMPLATES = new UserDirectory(
            GlibUserDirectory.DIRECTORY_TEMPLATES, "TEMPLATES");

    /**
     * Represents Videos directory of the user.
     */
    public static final UserDirectory VIDEOS = new UserDirectory(GlibUserDirectory.DIRECTORY_VIDEOS,
            "VIDEOS");
}
