HOM/HOM_galleries.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.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_galleries_h__
#define __HOM_galleries_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_ElemPtr.h"
#include <vector>

class HOM_Node;
class HOM_NodeType;
class HOM_Gallery;
class HOM_GalleryEntry;

SWIGOUT(%rename(galleries) HOM_galleries;)

class HOM_API HOM_galleries
{
public:
    virtual ~HOM_galleries()
    {}

    virtual std::string __repr__() throw(HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "galleries(self) -> tuple of Gallerys") galleries;)
    virtual std::vector<HOM_ElemPtr<HOM_Gallery> > galleries()
        throw(HOM_Error) = 0;

    SWIGOUT(%kwargs galleryEntries;)
    SWIGPYTHONOUT(%feature("autodoc",
        "galleryEntries(self, name_pattern=None, label_pattern=None,"
        " keyword_pattern=None, category=None, node_type=None)"
        " -> tuple of GalleryEntrys") galleryEntries;)
    virtual std::vector<HOM_ElemPtr<HOM_GalleryEntry> > galleryEntries(
            const char *name_pattern = NULL,
            const char *label_pattern = NULL,
            const char *keyword_pattern = NULL,
            const char *category = NULL,
            HOM_NodeType *node_type = NULL)
        throw(HOM_Error) = 0;

    SWIGOUT(%newobject installGallery;)
    SWIGPYTHONOUT(%feature("autodoc",
        "installGallery(self, gallery_path) -> "
        "Gallery or None") installGallery;)
    virtual HOM_Gallery *installGallery(const char *gallery_path)
        throw(HOM_OperationFailed, HOM_Error) = 0;

    SWIGOUT(%newobject createGalleryEntry;)
    SWIGPYTHONOUT(%feature("autodoc",
        "createGalleryEntry(self, gallery_path, entry_name, node) -> "
        "GalleryEntry or None") createGalleryEntry;)
    virtual HOM_GalleryEntry *createGalleryEntry(const char *gallery_path,
            const char *entry_name,
            HOM_Node *node = NULL)
        throw(HOM_PermissionError, HOM_OperationFailed,
              HOM_ObjectWasDeleted, HOM_Error) = 0;
};

#endif

---