fo-property-keep-together-within-page

fo-property-keep-together-within-page —

Synopsis




struct      FoPropertyKeepTogetherWithinPage;
struct      FoPropertyKeepTogetherWithinPageClass;
FoProperty* fo_property_keep_together_within_page_new
                                            (void);
FoDatatype* fo_property_keep_together_within_page_get_value
                                            (FoProperty *property);
void        fo_property_keep_together_within_page_set_value
                                            (FoProperty *property,
                                             FoDatatype *new_value);
FoProperty* fo_property_keep_together_within_page_new_from_expression
                                            (const gchar *expression,
                                             FoContext *context,
                                             FoProperty *current_font_size,
                                             FoFo *fo_node,
                                             GError **error);
FoProperty* fo_property_keep_together_within_page_get_initial
                                            (void);

Description

Details

struct FoPropertyKeepTogetherWithinPage

struct FoPropertyKeepTogetherWithinPage;


struct FoPropertyKeepTogetherWithinPageClass

struct FoPropertyKeepTogetherWithinPageClass;


fo_property_keep_together_within_page_new ()

FoProperty* fo_property_keep_together_within_page_new
                                            (void);

Creates a new FoPropertyKeepTogetherWithinPage initialized to default value.


fo_property_keep_together_within_page_get_value ()

FoDatatype* fo_property_keep_together_within_page_get_value
                                            (FoProperty *property);

Returns the current value property value of property

property : FoProperty object whose value is to be retrieved
Returns : The current value property value

fo_property_keep_together_within_page_set_value ()

void        fo_property_keep_together_within_page_set_value
                                            (FoProperty *property,
                                             FoDatatype *new_value);

Sets the value property of property

property : FoProperty object whose value is to be set
new_value : New value for the property

fo_property_keep_together_within_page_new_from_expression ()

FoProperty* fo_property_keep_together_within_page_new_from_expression
                                            (const gchar *expression,
                                             FoContext *context,
                                             FoProperty *current_font_size,
                                             FoFo *fo_node,
                                             GError **error);

Evaluates expression w.r.t. context and current_font_size. Returns an FoProperty object of correct type if expression evaluated without error, or NULL if an error occurred.

expression : Expression to evaluate
context : FoContext object from which to possibly inherit values
current_font_size : Current font size
fo_node : Formatting object on which property expression was declared
error : Information about an error that has occurred
Returns : FoProperty object representing resolved expression, or NULL

fo_property_keep_together_within_page_get_initial ()

FoProperty* fo_property_keep_together_within_page_get_initial
                                            (void);

Returns an instance of the property with the correct initial value

Returns : An instance of the property