xchildlist.h

Go to the documentation of this file.

/*
 *                           0BSD 
 * 
 *                    BSD Zero Clause License
 * 
 *  Copyright (c) 2019 Hermann Meyer
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted.
 
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 *
 */
 
#pragma once
 
#ifndef XCHILDLIST_H_
#define XCHILDLIST_H_
 
#include "xputty.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/**
 * 
 * @brief Childlist_t       - struct to hold a Widget_t child list
 * \n Xputty main holds a list of any Widget_t created in relation to main
 * \n Any Event is only propagate to Widget_t's found in this list
 * \n Every Widget_t holds a list of Child Widget_t's they contain
 * \n When a Widget_t get destroy_widget() call, all of it's childs
 * receive a destroy_widget() call before the Widget_t itself get destroyed
 * \n the expose_callback() (EXPOSE) and the configure_callback() (CONFIGURE)
 * will be propagate to all childs in a Childlist_t
 * @param **childs          - dynamic array to hold pointers to the childs
 * @param size              - current size of array
 * @param cap               - current capacity of the array
 * @param elem              - current elements in the array 
 */
 
struct Childlist_t {
/** dynamic array to hold pointers to the childs */
    Widget_t **childs;
/** current size of array */
    size_t size;
/** current capacity of the array */
    int cap;
/** current elements in the array  */
    int elem;
};
 
/**
 * @brief childlist_init      - internal use to allocate the array to min size
 * \n You usually didn't need to call this
 * @param *childlist          - pointer to the Childlist_t
 * @return void 
 */
 
void childlist_init(Childlist_t *childlist);
 
/**
 * @brief childlist_destroy   - internal use to free the Childlist_t
 * \n You usually didn't need to call this
 * @param *childlist          - pointer to the Childlist_t
 * @return void 
 */
 
void childlist_destroy(Childlist_t *childlist);
 
/**
 * @brief childlist_add_child - internal use to add a child to the Childlist_t
 * \n You usually didn't need to call this
 * @param *childlist          - pointer to the Childlist_t
 * @param *child              - pointer to the child to add
 * @return void 
 */
 
void childlist_add_child(Childlist_t *childlist, Widget_t *child);
 
/**
 * @brief childlist_remove_child - internal use to remove a child from the childlist
 * \n You usually didn't need to call this
 * @param *childlist             - pointer to the Childlist_t
 * @param *child                 - pointer to the child to remove
 * @return void 
 */
 
void childlist_remove_child(Childlist_t *childlist, Widget_t *child);
 
/**
 * @brief childlist_find_child - find a child in a the Childlist_t
 * this could be sued to check if a Widget_t is a child of a other Widget_t
 * @param *childlist           - pointer to the Childlist_t
 * @param *child               - pointer to the child to find
 * @return int                 - return position in childlist or -1 
 * when not found
 */
 
int childlist_find_child(Childlist_t *childlist, Widget_t *child);
 
/**
 * @brief childlist_find_widget - find a child Widget_t in a the childlist
 * by given the Window id 
 * @param *childlist            - pointer to the Childlist_t
 * @param child_window          - the Window to find the Widget_t for
 * @return int                  - return position in childlist or -1 
 * when not found
 */
 
int childlist_find_widget(Childlist_t *childlist, Window child_window);
 
/**
 * @brief childlist_has_child  - check if a Widget_t Childlist_t contain a child
 * @param *childlist           - pointer to the Childlist_t
 * @return int                 - return element counter value
 * 0 when Widget_t Childlist_t didn't contain a child
 */
 
int childlist_has_child(Childlist_t *childlist);
 
#ifdef __cplusplus
}
#endif
 
#endif //XCHILDLISTT_H_