isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-11-23 16:40:41 -05:00
Code Issues Packages Projects Releases Wiki Activity
1892f8cb1d
mutter/clutter/clutter-text.h

198 lines
11 KiB
C
Raw Normal View History

Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
Add text-visibility accessors for ClutterText A ClutterText can be put in "password mode" by setting the text as "invisible": every character inside the Text actor's contents will be replaced when building the Pango layout with a specific Unicode character. The Unicode character is set to '*' by default, but the user can be changed using the provided API.
2008-12-11 06:40:55 -05:00
* Copyright (C) 2008 Intel Corporation.
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
*
Add text-visibility accessors for ClutterText A ClutterText can be put in "password mode" by setting the text as "invisible": every character inside the Text actor's contents will be replaced when building the Pango layout with a specific Unicode character. The Unicode character is set to '*' by default, but the user can be changed using the provided API.
2008-12-11 06:40:55 -05:00
* Authored By: Øyvind Kolås <pippin@o-hand.com>
* Emmanuele Bassi <ebassi@linux.intel.com>
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
Expose the Text accessors as public API Fix up the header to expose ClutterText accessors for the main properties, matching ClutterLabel.
2008-12-11 06:20:14 -05:00
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
*/
Expose the Text accessors as public API Fix up the header to expose ClutterText accessors for the main properties, matching ClutterLabel.
2008-12-11 06:20:14 -05:00
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
#ifndef __CLUTTER_TEXT_H__
#define __CLUTTER_TEXT_H__
Add text-visibility accessors for ClutterText A ClutterText can be put in "password mode" by setting the text as "invisible": every character inside the Text actor's contents will be replaced when building the Pango layout with a specific Unicode character. The Unicode character is set to '*' by default, but the user can be changed using the provided API.
2008-12-11 06:40:55 -05:00
#include <clutter/clutter-actor.h>
#include <pango/pango.h>
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
G_BEGIN_DECLS
Expose the Text accessors as public API Fix up the header to expose ClutterText accessors for the main properties, matching ClutterLabel.
2008-12-11 06:20:14 -05:00
#define CLUTTER_TYPE_TEXT (clutter_text_get_type ())
#define CLUTTER_TEXT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_TEXT, ClutterText))
#define CLUTTER_TEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_TEXT, ClutterTextClass))
#define CLUTTER_IS_TEXT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_TEXT))
#define CLUTTER_IS_TEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_TEXT))
#define CLUTTER_TEXT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_TEXT, ClutterTextClass))
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
typedef struct _ClutterText ClutterText;
typedef struct _ClutterTextPrivate ClutterTextPrivate;
typedef struct _ClutterTextClass ClutterTextClass;
[docs] Add annotations for ClutterText structures ClutterText and ClutterTextClass were missing annotations for gtk-doc to pick up.
2008-12-15 10:10:55 -05:00
/**
* ClutterText:
*
* The #ClutterText struct contains only private data.
*
* Since: 1.0
*/
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
struct _ClutterText
{
/*< private >*/
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
ClutterActor parent_instance;
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
ClutterTextPrivate *priv;
};
[docs] Add annotations for ClutterText structures ClutterText and ClutterTextClass were missing annotations for gtk-doc to pick up.
2008-12-15 10:10:55 -05:00
/**
* ClutterTextClass:
* @text_changed: class handler for the #ClutterText::text-changed signal
* @activate: class handler for the #ClutterText::activate signal
* @cursor_event: class handler for the #ClutterText::cursor_event signal
*
* The #ClutterTextClass struct contains only private data.
*
* Since: 1.0
*/
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
struct _ClutterTextClass
{
Add text-visibility accessors for ClutterText A ClutterText can be put in "password mode" by setting the text as "invisible": every character inside the Text actor's contents will be replaced when building the Pango layout with a specific Unicode character. The Unicode character is set to '*' by default, but the user can be changed using the provided API.
2008-12-11 06:40:55 -05:00
/*< private >*/
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
ClutterActorClass parent_class;
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
Add text-visibility accessors for ClutterText A ClutterText can be put in "password mode" by setting the text as "invisible": every character inside the Text actor's contents will be replaced when building the Pango layout with a specific Unicode character. The Unicode character is set to '*' by default, but the user can be changed using the provided API.
2008-12-11 06:40:55 -05:00
/*< public >*/
Constify the cursor geometry in ::cursor-event We don't allow changing the cursor geometry inside the ::cursor-event signal handlers; for starters, it would make binding the signal a huge mess, and it would also potentially break the whole actor.
2008-12-15 13:23:25 -05:00
/* signals, not vfuncs */
void (* text_changed) (ClutterText *self);
void (* activate) (ClutterText *self);
void (* cursor_event) (ClutterText *self,
const ClutterGeometry *geometry);
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
Add text-visibility accessors for ClutterText A ClutterText can be put in "password mode" by setting the text as "invisible": every character inside the Text actor's contents will be replaced when building the Pango layout with a specific Unicode character. The Unicode character is set to '*' by default, but the user can be changed using the provided API.
2008-12-11 06:40:55 -05:00
/*< private >*/
/* padding for future expansion */
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
void (* _clutter_reserved1) (void);
void (* _clutter_reserved2) (void);
void (* _clutter_reserved3) (void);
void (* _clutter_reserved4) (void);
void (* _clutter_reserved5) (void);
void (* _clutter_reserved6) (void);
void (* _clutter_reserved7) (void);
void (* _clutter_reserved8) (void);
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
};
GType clutter_text_get_type (void) G_GNUC_CONST;
Add missing basic constructor ClutterText should have an empty constructor, mostly for bindings to use, that just proxies call to g_object_new() without setting any property.
2008-12-11 06:43:37 -05:00
ClutterActor * clutter_text_new (void);
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
ClutterActor * clutter_text_new_full (const gchar *font_name,
const gchar *text,
const ClutterColor *color);
ClutterActor * clutter_text_new_with_text (const gchar *font_name,
const gchar *text);
G_CONST_RETURN gchar *clutter_text_get_text (ClutterText *self);
void clutter_text_set_text (ClutterText *self,
const gchar *text);
PangoLayout * clutter_text_get_layout (ClutterText *self);
void clutter_text_set_color (ClutterText *self,
const ClutterColor *color);
void clutter_text_get_color (ClutterText *self,
ClutterColor *color);
void clutter_text_set_font_name (ClutterText *self,
const gchar *font_name);
G_CONST_RETURN gchar *clutter_text_get_font_name (ClutterText *self);
void clutter_text_set_ellipsize (ClutterText *self,
PangoEllipsizeMode mode);
PangoEllipsizeMode clutter_text_get_ellipsize (ClutterText *self);
void clutter_text_set_line_wrap (ClutterText *self,
Fix documentation issues Provide a description for the ClutterText section, and fix some misnamed arguments inside the header file.
2008-12-11 10:00:22 -05:00
gboolean line_wrap);
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
gboolean clutter_text_get_line_wrap (ClutterText *self);
void clutter_text_set_line_wrap_mode (ClutterText *self,
PangoWrapMode wrap_mode);
PangoWrapMode clutter_text_get_line_wrap_mode (ClutterText *self);
PangoLayout * clutter_text_get_layout (ClutterText *self);
void clutter_text_set_attributes (ClutterText *self,
PangoAttrList *attrs);
PangoAttrList * clutter_text_get_attributes (ClutterText *self);
void clutter_text_set_use_markup (ClutterText *self,
gboolean setting);
gboolean clutter_text_get_use_markup (ClutterText *self);
void clutter_text_set_alignment (ClutterText *self,
PangoAlignment alignment);
PangoAlignment clutter_text_get_alignment (ClutterText *self);
void clutter_text_set_justify (ClutterText *self,
gboolean justify);
gboolean clutter_text_get_justify (ClutterText *self);
void clutter_text_insert_unichar (ClutterText *self,
gunichar wc);
void clutter_text_delete_chars (ClutterText *self,
Fix documentation issues Provide a description for the ClutterText section, and fix some misnamed arguments inside the header file.
2008-12-11 10:00:22 -05:00
guint n_chars);
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
void clutter_text_insert_text (ClutterText *self,
const gchar *text,
gssize position);
void clutter_text_delete_text (ClutterText *self,
gssize start_pos,
gssize end_pos);
Add Text::get_chars() method declaration Add the declaration for a clutter_text_get_chars() function that returns a portion of the contents of a Text actor.
2008-12-11 06:31:48 -05:00
gchar * clutter_text_get_chars (ClutterText *self,
gssize start_pos,
gssize end_pos);
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
void clutter_text_set_editable (ClutterText *self,
gboolean editable);
gboolean clutter_text_get_editable (ClutterText *self);
void clutter_text_set_activatable (ClutterText *self,
gboolean activatable);
gboolean clutter_text_get_activatable (ClutterText *self);
gint clutter_text_get_cursor_position (ClutterText *self);
void clutter_text_set_cursor_position (ClutterText *self,
gint position);
void clutter_text_set_cursor_visible (ClutterText *self,
gboolean cursor_visible);
gboolean clutter_text_get_cursor_visible (ClutterText *self);
void clutter_text_set_cursor_color (ClutterText *self,
const ClutterColor *color);
void clutter_text_get_cursor_color (ClutterText *self,
ClutterColor *color);
Add :cursor-size property to ClutterText We can control the width of the cursor when painting by using a simple property. The magic -1 number passed to the setter method will reset the cursor size to the default one of 2px. The getter method will return an unsigned integer with the current size.
2008-12-16 05:37:45 -05:00
void clutter_text_set_cursor_size (ClutterText *self,
gint size);
guint clutter_text_get_cursor_size (ClutterText *self);
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
void clutter_text_set_selectable (ClutterText *self,
gboolean selectable);
gboolean clutter_text_get_selectable (ClutterText *self);
void clutter_text_set_selection_bound (ClutterText *self,
gint selection_bound);
gint clutter_text_get_selection_bound (ClutterText *self);
Add ClutterText::set_selection() The clutter_text_set_selection() function is a convenience method for setting the cursor position and the selection boundary to a given position in a single call, with sanity checks for the positions.
2008-12-16 07:41:20 -05:00
void clutter_text_set_selection (ClutterText *self,
gssize start_pos,
gssize end_pos);
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
gchar * clutter_text_get_selection (ClutterText *self);
Add text-visibility accessors for ClutterText A ClutterText can be put in "password mode" by setting the text as "invisible": every character inside the Text actor's contents will be replaced when building the Pango layout with a specific Unicode character. The Unicode character is set to '*' by default, but the user can be changed using the provided API.
2008-12-11 06:40:55 -05:00
void clutter_text_set_text_visible (ClutterText *self,
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
gboolean visible);
Add text-visibility accessors for ClutterText A ClutterText can be put in "password mode" by setting the text as "invisible": every character inside the Text actor's contents will be replaced when building the Pango layout with a specific Unicode character. The Unicode character is set to '*' by default, but the user can be changed using the provided API.
2008-12-11 06:40:55 -05:00
gboolean clutter_text_get_text_visible (ClutterText *self);
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
void clutter_text_set_invisible_char (ClutterText *self,
Add text-visibility accessors for ClutterText A ClutterText can be put in "password mode" by setting the text as "invisible": every character inside the Text actor's contents will be replaced when building the Pango layout with a specific Unicode character. The Unicode character is set to '*' by default, but the user can be changed using the provided API.
2008-12-11 06:40:55 -05:00
gunichar wc);
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
gunichar clutter_text_get_invisible_char (ClutterText *self);
void clutter_text_set_max_length (ClutterText *self,
Add text-visibility accessors for ClutterText A ClutterText can be put in "password mode" by setting the text as "invisible": every character inside the Text actor's contents will be replaced when building the Pango layout with a specific Unicode character. The Unicode character is set to '*' by default, but the user can be changed using the provided API.
2008-12-11 06:40:55 -05:00
gint max);
Merge Label and Entry API into ClutterText ClutterText should expose both ClutterLabel and ClutterEntry functionality using an API that matches the one provided by those two classes.
2008-12-11 06:21:39 -05:00
gint clutter_text_get_max_length (ClutterText *self);
Add ClutterText::activate() The clutter_text_activate() function will emit the ::activate signal if the :activatable property is set. This function is useful for subclasses or application code, for example if we are going to use ::captured-event or ::key-press-event signal handlers to intercept the Return key and emit the ::activate signal ourselves.
2008-12-16 07:02:58 -05:00
gboolean clutter_text_activate (ClutterText *self);
Initial import of the Text actor from Tidy The TidyText actor is meant as a replacement for both ClutterLabel and ClutterText. Any text-displaying and editing actor should derive from ClutterText and implement the various visual cues to differentiate the editable from the non-editable state. Those visual cues usually belong to a high-level toolkit, especially if themeing is involved.
2008-12-11 06:12:48 -05:00
G_END_DECLS
#endif /* __CLUTTER_TEXT_H__ */
Reference in New Issue Copy Permalink