Code

Fixed signed/unsigned problem with precision calc. Fixes bug #399604.
[inkscape.git] / src / ege-output-action.h
1 #ifndef SEEN_EGE_OUTPUT_ACTION
2 #define SEEN_EGE_OUTPUT_ACTION
3 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
4  *
5  */
6 /* ***** BEGIN LICENSE BLOCK *****
7  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
8  *
9  * The contents of this file are subject to the Mozilla Public License Version
10  * 1.1 (the "License"); you may not use this file except in compliance with
11  * the License. You may obtain a copy of the License at
12  * http://www.mozilla.org/MPL/
13  *
14  * Software distributed under the License is distributed on an "AS IS" basis,
15  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
16  * for the specific language governing rights and limitations under the
17  * License.
18  *
19  * The Original Code is EGE Output Action.
20  *
21  * The Initial Developer of the Original Code is
22  * Jon A. Cruz.
23  * Portions created by the Initial Developer are Copyright (C) 2007
24  * the Initial Developer. All Rights Reserved.
25  *
26  * Contributor(s):
27  *
28  * Alternatively, the contents of this file may be used under the terms of
29  * either the GNU General Public License Version 2 or later (the "GPL"), or
30  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
31  * in which case the provisions of the GPL or the LGPL are applicable instead
32  * of those above. If you wish to allow use of your version of this file only
33  * under the terms of either the GPL or the LGPL, and not to allow others to
34  * use your version of this file under the terms of the MPL, indicate your
35  * decision by deleting the provisions above and replace them with the notice
36  * and other provisions required by the GPL or the LGPL. If you do not delete
37  * the provisions above, a recipient may use your version of this file under
38  * the terms of any one of the MPL, the GPL or the LGPL.
39  *
40  * ***** END LICENSE BLOCK ***** */
42 /** \file
43  *  GtkAction subclass that represents a string for output.
44  */
46 /* Note: this file should be kept compilable as both .cpp and .c */
48 #include <glib.h>
49 #include <gtk/gtkaction.h>
50 #include <glib-object.h>
52 G_BEGIN_DECLS
55 #define EGE_OUTPUT_ACTION_TYPE                ( ege_output_action_get_type() )
56 #define EGE_OUTPUT_ACTION( obj )              ( G_TYPE_CHECK_INSTANCE_CAST( (obj), EGE_OUTPUT_ACTION_TYPE, EgeOutputAction) )
57 #define EGE_OUTPUT_ACTION_CLASS( klass )      ( G_TYPE_CHECK_CLASS_CAST( (klass), EGE_OUTPUT_ACTION_TYPE, EgeOutputActionClass) )
58 #define IS_EGE_OUTPUT_ACTION( obj )           ( G_TYPE_CHECK_INSTANCE_TYPE( (obj), EGE_OUTPUT_ACTION_TYPE) )
59 #define IS_EGE_OUTPUT_ACTION_CLASS( klass )   ( G_TYPE_CHECK_CLASS_TYPE( (klass), EGE_OUTPUT_ACTION_TYPE) )
60 #define EGE_OUTPUT_ACTION_GET_CLASS( obj )    ( G_TYPE_INSTANCE_GET_CLASS( (obj), EGE_OUTPUT_ACTION_TYPE, EgeOutputActionClass) )
62 typedef struct _EgeOutputAction      EgeOutputAction;
63 typedef struct _EgeOutputActionClass EgeOutputActionClass;
64 typedef struct _EgeOutputActionPrivate EgeOutputActionPrivate;
66 /**
67  * Instance structure of EgeOutputAction.
68  */
69 struct _EgeOutputAction
70 {
71     /** Parent instance structure. */
72     GtkAction action;
74     /** Pointer to private instance data. */
75     EgeOutputActionPrivate *private_data;
76 };
78 /**
79  * Class structure of EgeOutputAction.
80  */
81 struct _EgeOutputActionClass
82 {
83     /** Parent class structure. */
84     GtkActionClass parent_class;
85 };
87 /** Standard Gtk type function */
88 GType ege_output_action_get_type( void );
90 /**
91  * Creates a new EgeOutputAction instance.
92  * This is a GtkAction subclass that displays a string.
93  *
94  * @param name Functional name for the action.
95  * @param label Display label for the action.
96  * @param tooltip Tooltip for the action.
97  * @param stock_id Icon id to use.
98  */
99 EgeOutputAction* ege_output_action_new( const gchar *name,
100                                         const gchar *label,
101                                         const gchar *tooltip,
102                                         const gchar *stock_id );
104 /**
105  * Return whether or not the displayed text is interpreted as markup.
106  *
107  * @param action The action to fetch the markup state for.
108  * @return True if the text is to be interpreted as markup, false otherwise.
109  */
110 gboolean ege_output_action_get_use_markup( EgeOutputAction* action );
112 /**
113  * Sets whether or not the displayed text is interpreted as markup.
114  *
115  * @param action The action to set the markup state for.
116  * @param setting True if the text is to be interpreted as markup, false otherwise.
117  */
118 void ege_output_action_set_use_markup( EgeOutputAction* action, gboolean setting );
120 G_END_DECLS
122 #endif /* SEEN_EGE_OUTPUT_ACTION */