ergtkcellrenderertext.h

Go to the documentation of this file.

#ifndef __ERGTK_CELL_RENDERER_TEXT_H__
#define __ERGTK_CELL_RENDERER_TEXT_H__

/**
 * File Name  : ergtkcellrenderertext.h
 *
 * Description: The erGtkCellRendererText object is a GtkCellRendererText
 *              that can display multiple text line in a single cell.
 *              It also can draw a border around the entire treeview entry
 *              to which it belongs.
 */

/*
 * This file is part of libergtk.
 *
 * libergtk 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.
 *
 * libergtk 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, see <http://www.gnu.org/licenses/>.
 */
 
/**
 * Copyright (C) 2009 iRex Technologies B.V.
 * All rights reserved.
 */

//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

// system include files, between < >
#include <glib.h>
#include <gtk/gtk.h>

// ereader include files, between < >

// local include files, between " "

G_BEGIN_DECLS


//----------------------------------------------------------------------------
// Macro Definitions
//---------------------------------------------------------------------------- 
#define ERGTK_CELL_RENDERER_TEXT_TYPE             (ergtk_cell_renderer_text_get_type())
#define ERGTK_CELL_RENDERER_TEXT(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), ERGTK_CELL_RENDERER_TEXT_TYPE, erGtkCellRendererText))
#define IS_ERGTK_CELL_RENDERER_TEXT(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), ERGTK_CELL_RENDERER_TEXT_TYPE))
                                                  
#define ERGTK_CELL_RENDERER_TEXT_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),  ERGTK_CELL_RENDERER_TEXT_TYPE, erGtkCellRendererTextClass))
#define ERGTK_CELL_RENDERER_TEXT_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),  ERGTK_CELL_RENDERER_TEXT_TYPE, erGtkCellRendererTextClass))
#define ISGTK_CELL_RENDERER_TEXT_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),  ERGTK_CELL_RENDERER_TEXT_TYPE))

#define ERGTK_CELL_RENDERER_TEXT_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), ERGTK_CELL_RENDERER_TEXT_TYPE, erGtkCellRendererTextPrivate))


//----------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------

struct _erGtkCellRendererText;
struct _erGtkCellRendererTextClass;


//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------

typedef struct _erGtkCellRendererText       erGtkCellRendererText;
typedef struct _erGtkCellRendererTextClass  erGtkCellRendererTextClass;


//----------------------------------------------------------------------------
// Global Constants
//----------------------------------------------------------------------------

#define ERGTK_CELL_RENDERER_TEXT_MAX_LINES      2       // maximum number of text lines supported


//============================================================================
// Public Functions
//============================================================================

/**---------------------------------------------------------------------------
 *
 * Name :  ergtk_cell_renderer_text_new
 *
 * @brief  Create a new erGtkCellRendererText object
 *
 * @param  [in] n_lines - the number of text lines to display
 *
 * @return Pointer to the newly created object, or NULL
 *
 *--------------------------------------------------------------------------*/
GtkCellRenderer *ergtk_cell_renderer_text_new (const guint n_lines);

/**---------------------------------------------------------------------------
 *
 * Name :  ergtk_cell_renderer_text_get_type
 *
 * @brief  Returns the GObject type of an erGtkCellRendererText
 *
 * @param  --
 *
 * @return The GObject type of an erGtkCellRendererText
 *
 *--------------------------------------------------------------------------*/
GType ergtk_cell_renderer_text_get_type (void);


//============================================================================
// Class Declarations
//============================================================================

/**===========================================================================
 *
 * Class Name: erGtkCellRendererTextClass
 *
 * @brief:     GObject class for erGtkCellRendererText objects
 *
 *==========================================================================*/
struct _erGtkCellRendererTextClass
{
    GtkCellRendererTextClass    parent_class;

    // virtual methods

    // signal handlers
};


/**===========================================================================
 *
 * Class Name: erGtkCellRendererText
 *
 * @brief:     A cell renderer similar to GtkCellRendererText but capable of
 *             rendering multiple lines of text inside a single cell.
 *             Properties to control this cell renderer:
 *               text-0,   text-1,   ..
 *                 Text to be displayed in 1st line, 2nd line, ..
 *                 As in GtkCellRendererText property "text".
 *               font-0,   font-1,   ..
 *                 Font description for 1st line, 2nd line, ..
 *                 As in GtkCellRendererText propery "font".
 *               height-0, height-1. ..
 *                 Height in pixels of 1st  line, 2nd line, ..
 *
 *==========================================================================*/
struct _erGtkCellRendererText
{
    // public:
    GtkCellRendererText parent;
};



G_END_DECLS

#endif // __ERGTK_CELL_RENDERER_TEXT_H__