CriaBlock

CriaBlock —

Synopsis




            CriaBlock;
            CriaBlockClass;
CriaAlignment cria_block_get_alignment      (CriaBlock *self);
GOColor     cria_block_get_color            (CriaBlock *self);
const gchar* cria_block_get_markup          (CriaBlock *self);
const gchar* cria_block_get_name            (CriaBlock *self);
GoRect*     cria_block_get_position         (CriaBlock *self);
CriaVAlignment cria_block_get_valignment    (CriaBlock *self);
CriaBlock*  cria_block_new                  (CriaSlide *slide,
                                             const gchar *name);
void        cria_block_set_alignment        (CriaBlock *self,
                                             CriaAlignment alignment);
void        cria_block_set_color            (CriaBlock *self,
                                             GOColor color);
void        cria_block_set_font_family      (CriaBlock *self,
                                             const gchar *family);
void        cria_block_set_font_size        (CriaBlock *self,
                                             const gchar *size);
void        cria_block_set_name             (CriaBlock *self,
                                             const gchar *name);
void        cria_block_set_text             (CriaBlock *self,
                                             const gchar *text);
void        cria_block_set_valignment       (CriaBlock *self,
                                             CriaVAlignment valignment);

Object Hierarchy


  GObject
   +----CriaBlock

Properties


  "alignment"            CriaAlignment         : Read / Write / Construct
  "bottom"               guint64               : Read / Write
  "left"                 guint64               : Read / Write
  "name"                 gchararray            : Read / Write / Construct
  "right"                guint64               : Read / Write
  "text"                 gchararray            : Read / Write
  "top"                  guint64               : Read / Write
  "valignment"           CriaVAlignment        : Read / Write / Construct

Signal Prototypes


"format-changed"
            void        user_function      (CriaBlock *criablock,
                                            CriaFormatDomain arg1,
                                            gpointer user_data);

Description

Details

CriaBlock

typedef struct _CriaBlock CriaBlock;


CriaBlockClass

typedef struct {
	GObjectClass	  base_class;

	void (*format_changed) (CriaBlock     * self,
				CriaFormatDomain  changed);
} CriaBlockClass;


cria_block_get_alignment ()

CriaAlignment cria_block_get_alignment      (CriaBlock *self);

Get the horizontal alignment of content in this block

self : the block to get the alignment from
Returns : the horizontal alignment of content

cria_block_get_color ()

GOColor     cria_block_get_color            (CriaBlock *self);

Get the foreground color of a text block.

self : a CriaBlock
Returns : the color of this text block; if it's not set it returns a default value.

cria_block_get_markup ()

const gchar* cria_block_get_markup          (CriaBlock *self);

Get the text that should be rendered into a block.

self : a CriaBlock
Returns : the text that should be rendered into a block

cria_block_get_name ()

const gchar* cria_block_get_name            (CriaBlock *self);

Get the name of a block.

self : a CriaBlock
Returns : a block's name.

cria_block_get_position ()

GoRect*     cria_block_get_position         (CriaBlock *self);

Get the position of a CriaBlock.

self : a CriaBlock
Returns : the block's position. May return NULL if unset.

cria_block_get_valignment ()

CriaVAlignment cria_block_get_valignment    (CriaBlock *self);

Get the vertical alignment of content in this block

self : the block to get the alignment from
Returns : the vertical alignment of content

cria_block_new ()

CriaBlock*  cria_block_new                  (CriaSlide *slide,
                                             const gchar *name);

slide :
name :
Returns :

cria_block_set_alignment ()

void        cria_block_set_alignment        (CriaBlock *self,
                                             CriaAlignment alignment);

self :
alignment :

cria_block_set_color ()

void        cria_block_set_color            (CriaBlock *self,
                                             GOColor color);

Set the foreground color of a text block.

self : a CriaBlock
color : a GOColor

cria_block_set_font_family ()

void        cria_block_set_font_family      (CriaBlock *self,
                                             const gchar *family);

self :
family :

cria_block_set_font_size ()

void        cria_block_set_font_size        (CriaBlock *self,
                                             const gchar *size);

Sets the font size.

self : a CriaBlock
size : a string specifying a font size

cria_block_set_name ()

void        cria_block_set_name             (CriaBlock *self,
                                             const gchar *name);

self :
name :

cria_block_set_text ()

void        cria_block_set_text             (CriaBlock *self,
                                             const gchar *text);

self :
text :

cria_block_set_valignment ()

void        cria_block_set_valignment       (CriaBlock *self,
                                             CriaVAlignment valignment);

self :
valignment :

Properties

The "alignment" property

  "alignment"            CriaAlignment         : Read / Write / Construct

The horizontal alignment of embedded elements.

Default value: CRIA_ALIGNMENT_UNSET


The "bottom" property

  "bottom"               guint64               : Read / Write

The width of the block.

Default value: 0


The "left" property

  "left"                 guint64               : Read / Write

The Position of the topleft corner of the layout box.

Default value: 0


The "name" property

  "name"                 gchararray            : Read / Write / Construct

The name of this block.

Default value: "untitled block"


The "right" property

  "right"                guint64               : Read / Write

The height of the block.

Default value: 0


The "text" property

  "text"                 gchararray            : Read / Write

The text contained in this block.

Default value: ""


The "top" property

  "top"                  guint64               : Read / Write

The vertical position of the block.

Default value: 0


The "valignment" property

  "valignment"           CriaVAlignment        : Read / Write / Construct

The vertical alignment of embedded elements.

Default value: CRIA_VALIGNMENT_UNSET

Signals

The "format-changed" signal

void        user_function                  (CriaBlock *criablock,
                                            CriaFormatDomain arg1,
                                            gpointer user_data);

criablock : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.