gds-render/layer/layer-selector.h

/*
 * GDSII-Converter
 * Copyright (C) 2018  Mario Hüttel <mario.huettel@gmx.net>
 *
 * This file is part of GDSII-Converter.
 *
 * GDSII-Converter is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * GDSII-Converter 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 GDSII-Converter.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * @file layer-selector.h
 * @brief Implementation of the Layer selection list
 * @author Mario Hüttel <mario.huettel@gmx.net>
 */

#ifndef __LAYER_SELECTOR_H__
#define __LAYER_SELECTOR_H__

#include <gtk/gtk.h>
#include <glib.h>

G_BEGIN_DECLS

G_DECLARE_FINAL_TYPE(LayerSelector, layer_selector, LAYER, SELECTOR, GObject);

#define TYPE_LAYER_SELECTOR (layer_selector_get_type())

/**
 * @brief Defines how to sort the layer selector list box.
 */
enum layer_selector_sort_algo {LAYER_SELECTOR_SORT_DOWN = 0, LAYER_SELECTOR_SORT_UP};

/**
 * @brief layer_selector_new
 * @param list_box The associated list box, the content is displayed in
 * @return Newly created layer selector
 */
LayerSelector *layer_selector_new(GtkListBox *list_box);

/**
 * @brief Generate layer widgets in in the LayerSelector instance
 * @note This clears all previously inserted elements
 * @param selector LayerSelector instance
 * @param libs The libraries to add
 */
void layer_selector_generate_layer_widgets(LayerSelector *selector, GList *libs);

/**
 * @brief Supply button for loading the layer mapping
 * @param selector LayerSelector instance
 * @param button Load button. Will be referenced
 * @param main_window Parent window for dialogs. Will be referenced
 */
void layer_selector_set_load_mapping_button(LayerSelector *selector, GtkWidget *button, GtkWindow *main_window);

/**
 * @brief Supply button for saving the layer mapping
 * @param selector LayerSelector instance
 * @param button Save button. Will be refeneced
 * @param main_window Parent window for dialogs. Will be referenced
 */
void layer_selector_set_save_mapping_button(LayerSelector *selector, GtkWidget *button, GtkWindow *main_window);

/**
 * @brief Get a list of all layers that shall be exported when rendering the cells
 * @param selector Layer selector instance
 * @return List of layer_info structures containing the layer information
 */
GList *layer_selector_export_rendered_layer_info(LayerSelector *selector);

/**
 * @brief Force the layer selector list to be sorted according to \p sort_function
 * @param selector LayerSelector instance
 * @param sort_function The sorting method (up or down sorting)
 */
void layer_selector_force_sort(LayerSelector *selector, enum layer_selector_sort_algo sort_function);

G_END_DECLS

#endif /* __LAYER_SELECTOR_H__ */