isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-26 12:52:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
115f6ee008
mutter/clutter/clutter-text.h

234 lines
14 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 11:12:48 +00: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 11:40:55 +00: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 11:12:48 +00: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 11:40:55 +00: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 11:12:48 +00: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 11:20:14 +00: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 11:12:48 +00: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 11:20:14 +00: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 11:12:48 +00: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 11:40:55 +00:00
#include <clutter/clutter-actor.h>
text: Implement ClutterTextBuffer * Abstracts the buffer for text in ClutterText * Allows implementation of undo/redo. * Allows use of non-pageable memory for text in the case of sensitive passwords. * Implement a test with two ClutterText using the same buffer. https://bugzilla.gnome.org/show_bug.cgi?id=652653
2011-06-15 09:06:31 +00:00
#include <clutter/clutter-text-buffer.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 11:40:55 +00:00
#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 11:12:48 +00: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 11:20:14 +00: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 11:12:48 +00: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 15:10:55 +00: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 11:12:48 +00: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 11:21:39 +00: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 11:12:48 +00:00
ClutterTextPrivate *priv;
};
[docs] Add annotations for ClutterText structures ClutterText and ClutterTextClass were missing annotations for gtk-doc to pick up.
2008-12-15 15:10:55 +00: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 11:12:48 +00: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 11:40:55 +00: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 11:21:39 +00: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 11:12:48 +00: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 11:40:55 +00: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 18:23:25 +00: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 11:21:39 +00: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 11:40:55 +00: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 11:21:39 +00: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 11:12:48 +00:00
};
GType clutter_text_get_type (void) G_GNUC_CONST;
Re-align ClutterText header file The addition of the single line mode accessor methods caused the re-alignment of the entire file.
2009-01-07 11:46:22 +00:00
ClutterActor * clutter_text_new (void);
text: Add :font-description High level toolkits might wish to construct a PangoFontDescription and then set it directly on a ClutterText actor proxy or sub-class. ClutterText should have a :font-description property to set (and get) the PangoFontDescription. http://bugzilla.openedhand.com/show_bug.cgi?id=1960
2010-02-03 14:35:45 +00: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);
text: Implement ClutterTextBuffer * Abstracts the buffer for text in ClutterText * Allows implementation of undo/redo. * Allows use of non-pageable memory for text in the case of sensitive passwords. * Implement a test with two ClutterText using the same buffer. https://bugzilla.gnome.org/show_bug.cgi?id=652653
2011-06-15 09:06:31 +00:00
ClutterActor * clutter_text_new_with_buffer (ClutterTextBuffer *buffer);
ClutterTextBuffer * clutter_text_get_buffer (ClutterText *self);
void clutter_text_set_buffer (ClutterText *self,
ClutterTextBuffer *buffer);
Eliminate G_CONST_RETURN The G_CONST_RETURN define in GLib is, and has always been, a bit fuzzy. We always used it to conform to the platform, at least for public-facing API. At first I assumed it has something to do with brain-damaged compilers or with weird platforms where const was not really supported; sadly, it's something much, much worse: it's a define that can be toggled at compile-time to remove const from the signature of public API. This is a truly terrifying feature that I assume was added in the past century, and whose inception clearly had something to do with massive doses of absynthe and opium — because any other explanation would make the existence of such a feature even worse than assuming drugs had anything to do with it. Anyway, and pleasing the gods, this dubious feature is being removed/deprecated in GLib; see bug: https://bugzilla.gnome.org/show_bug.cgi?id=644611 Before deprecation, though, we should just remove its usage from the whole API. We should especially remove its usage from Cally's internals, since there it never made sense in the first place.
2011-06-07 14:49:20 +00:00
const gchar * clutter_text_get_text (ClutterText *self);
text: Add :font-description High level toolkits might wish to construct a PangoFontDescription and then set it directly on a ClutterText actor proxy or sub-class. ClutterText should have a :font-description property to set (and get) the PangoFontDescription. http://bugzilla.openedhand.com/show_bug.cgi?id=1960
2010-02-03 14:35:45 +00:00
void clutter_text_set_text (ClutterText *self,
const gchar *text);
void clutter_text_set_markup (ClutterText *self,
const gchar *markup);
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);
Eliminate G_CONST_RETURN The G_CONST_RETURN define in GLib is, and has always been, a bit fuzzy. We always used it to conform to the platform, at least for public-facing API. At first I assumed it has something to do with brain-damaged compilers or with weird platforms where const was not really supported; sadly, it's something much, much worse: it's a define that can be toggled at compile-time to remove const from the signature of public API. This is a truly terrifying feature that I assume was added in the past century, and whose inception clearly had something to do with massive doses of absynthe and opium — because any other explanation would make the existence of such a feature even worse than assuming drugs had anything to do with it. Anyway, and pleasing the gods, this dubious feature is being removed/deprecated in GLib; see bug: https://bugzilla.gnome.org/show_bug.cgi?id=644611 Before deprecation, though, we should just remove its usage from the whole API. We should especially remove its usage from Cally's internals, since there it never made sense in the first place.
2011-06-07 14:49:20 +00:00
const gchar * clutter_text_get_font_name (ClutterText *self);
text: Add :font-description High level toolkits might wish to construct a PangoFontDescription and then set it directly on a ClutterText actor proxy or sub-class. ClutterText should have a :font-description property to set (and get) the PangoFontDescription. http://bugzilla.openedhand.com/show_bug.cgi?id=1960
2010-02-03 14:35:45 +00:00
void clutter_text_set_font_description (ClutterText *self,
PangoFontDescription *font_desc);
PangoFontDescription *clutter_text_get_font_description (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,
gboolean line_wrap);
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_line_alignment (ClutterText *self,
PangoAlignment alignment);
PangoAlignment clutter_text_get_line_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,
guint n_chars);
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);
gchar * clutter_text_get_chars (ClutterText *self,
gssize start_pos,
gssize end_pos);
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);
void clutter_text_set_cursor_size (ClutterText *self,
gint size);
guint clutter_text_get_cursor_size (ClutterText *self);
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);
void clutter_text_set_selection (ClutterText *self,
gssize start_pos,
gssize end_pos);
gchar * clutter_text_get_selection (ClutterText *self);
void clutter_text_set_selection_color (ClutterText *self,
const ClutterColor *color);
void clutter_text_get_selection_color (ClutterText *self,
ClutterColor *color);
gboolean clutter_text_delete_selection (ClutterText *self);
void clutter_text_set_password_char (ClutterText *self,
gunichar wc);
gunichar clutter_text_get_password_char (ClutterText *self);
void clutter_text_set_max_length (ClutterText *self,
gint max);
gint clutter_text_get_max_length (ClutterText *self);
void clutter_text_set_single_line_mode (ClutterText *self,
gboolean single_line);
gboolean clutter_text_get_single_line_mode (ClutterText *self);
clutter-text: Add a selected-text-color http://bugzilla.clutter-project.org/show_bug.cgi?id=2595
2011-03-02 17:02:56 +00:00
void clutter_text_set_selected_text_color (ClutterText *self,
const ClutterColor *color);
void clutter_text_get_selected_text_color (ClutterText *self,
ClutterColor *color);
text: Add :font-description High level toolkits might wish to construct a PangoFontDescription and then set it directly on a ClutterText actor proxy or sub-class. ClutterText should have a :font-description property to set (and get) the PangoFontDescription. http://bugzilla.openedhand.com/show_bug.cgi?id=1960
2010-02-03 14:35:45 +00:00
gboolean clutter_text_activate (ClutterText *self);
text: Add the coords_to_position() method The reverse of position_to_coords(). While providing documentation on how to implement it using the PangoLayout API, I realized that the verbosity of it all, plus the usage of the Pango API, was not worth it, and decided to expose the method we are using internally.
2012-02-06 18:23:21 +00:00
gint clutter_text_coords_to_position (ClutterText *self,
gfloat x,
gfloat y);
text: Add :font-description High level toolkits might wish to construct a PangoFontDescription and then set it directly on a ClutterText actor proxy or sub-class. ClutterText should have a :font-description property to set (and get) the PangoFontDescription. http://bugzilla.openedhand.com/show_bug.cgi?id=1960
2010-02-03 14:35:45 +00:00
gboolean clutter_text_position_to_coords (ClutterText *self,
gint position,
gfloat *x,
gfloat *y,
gfloat *line_height);
void clutter_text_set_preedit_string (ClutterText *self,
const gchar *preedit_str,
PangoAttrList *preedit_attrs,
guint cursor_pos);
[text] Add pre-edit string to ClutterText Input Methods require to be able to set a "pre-edit string", that is a string that it's just displayed into the Text actor without being committed to the actor's buffer. The string might require custom Pango attributes, and an update of the cursor position.
2009-09-09 11:15:23 +00:00
clutter-text: new clutter_text_get_layout_offsets API This new function can be used to retrieve the coordinates where the ClutterText will draw the PangoLayout representing the text. http://bugzilla.clutter-project.org/show_bug.cgi?id=2553
2011-02-04 11:33:53 +00:00
void clutter_text_get_layout_offsets (ClutterText *self,
gint *x,
gint *y);
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 11:12:48 +00:00
G_END_DECLS
#endif /* __CLUTTER_TEXT_H__ */
Reference in New Issue Copy Permalink