diff options
Diffstat (limited to 'slv2/category.h')
-rw-r--r-- | slv2/category.h | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/slv2/category.h b/slv2/category.h new file mode 100644 index 0000000..1d0159f --- /dev/null +++ b/slv2/category.h @@ -0,0 +1,70 @@ +/* SLV2 + * Copyright (C) 2007 Dave Robillard <http://drobilla.net> + * + * This library is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the Free + * Software Foundation; either version 2 of the License, or (at your option) + * any later version. + * + * This library 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 GNU General Public License + * for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef __SLV2_CATEGORY_H__ +#define __SLV2_CATEGORY_H__ + +#ifdef __cplusplus +extern "C" { +#endif + +#include <slv2/types.h> + +/** \addtogroup data + * @{ + */ + + +/** Get the URI of this category. + * + * Returned value is owned by \a category and must not be freed by caller. + * + * Time = O(1) + */ +const char* slv2_category_get_uri(SLV2Category category); + + +/** Get the label of this category, ie "Oscillators". + * + * Returned value is owned by \a category and must not be freed by caller. + * + * Time = O(1) + */ +const char* slv2_category_get_label(SLV2Category category); + +#if 0 +/** Get the path of this category, ie "Plugins/Generators/Oscillators". + * + * SLV2 automatically generates an ideal category heirarchy given the plugins + * present. The last fragment of the path is the category's label, + * as returned by slv2_category_get_label. + * + * Returned value is owned by \a category and must not be freed by caller. + * + * Time = O(1) + */ +const char* slv2_category_get_path(SLV2Category category); +#endif + +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif /* __SLV2_CATEGORY_H__ */ |