isa/gnome-shell
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2e02918323
gnome-shell/src/st/st-widget.h

172 lines
7.8 KiB
C
Raw Normal View History

Add emacs mode-lines to ST sources To each .c and .h file, add: /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */ 'gnu' is the default anyways for Emacs, but indent-tabs-mode is not, so this sets things up to correspond to the policy of no-tabs. http://bugzilla.moblin.org/show_bug.cgi?id=6467
2009-09-29 19:08:01 +00:00
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
Import Mx core as ST Import the core MxWidget/MxBin and their dependencies; we use the namespace "St" (Shell Toolkit) because it is the same length as Mx so enabling easy sharing of code, but makes it clear that this is a friendly fork and not a literal import. Based on a patch by Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=591245
2009-09-08 19:47:30 +00:00
/*
* st-widget.h: Base class for St actors
*
* Copyright 2007 OpenedHand
* Copyright 2008, 2009 Intel Corporation.
Fix up copyright and license notices for St * Make sure all source files have a LGPL copyright header, and standardize non-standard variations of the header to a common form. * Check and update all copyright notices. * Remove 'Written By:' lines. They are universally incomplete and typically indicate only who started a particular file. https://bugzilla.gnome.org/show_bug.cgi?id=634550
2010-11-10 22:00:45 +00:00
* Copyright 2009, 2010 Red Hat, Inc.
* Copyright 2009 Abderrahim Kitouni
* Copyright 2010 Florian Müllner
Import Mx core as ST Import the core MxWidget/MxBin and their dependencies; we use the namespace "St" (Shell Toolkit) because it is the same length as Mx so enabling easy sharing of code, but makes it clear that this is a friendly fork and not a literal import. Based on a patch by Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=591245
2009-09-08 19:47:30 +00:00
*
* This program is free software; you can redistribute it and/or modify it
* under the terms and conditions of the GNU Lesser General Public License,
* version 2.1, as published by the Free Software Foundation.
*
* This program is distributed in the hope 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 License
Fix up copyright and license notices for St * Make sure all source files have a LGPL copyright header, and standardize non-standard variations of the header to a common form. * Check and update all copyright notices. * Remove 'Written By:' lines. They are universally incomplete and typically indicate only who started a particular file. https://bugzilla.gnome.org/show_bug.cgi?id=634550
2010-11-10 22:00:45 +00:00
* along with this program. If not, see <http://www.gnu.org/licenses/>.
Import Mx core as ST Import the core MxWidget/MxBin and their dependencies; we use the namespace "St" (Shell Toolkit) because it is the same length as Mx so enabling easy sharing of code, but makes it clear that this is a friendly fork and not a literal import. Based on a patch by Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=591245
2009-09-08 19:47:30 +00:00
*/
#if !defined(ST_H_INSIDE) && !defined(ST_COMPILATION)
#error "Only <st/st.h> can be included directly.h"
#endif
#ifndef __ST_WIDGET_H__
#define __ST_WIDGET_H__
#include <clutter/clutter.h>
#include <st/st-types.h>
Port our imported parts of Mx to ShellTheme ShellTheme replaces both StStyle and ccss_stylesheet_t. The interface StStylable is replaced by usage of ShellThemeNode. A concrete node class allows some significant optimizations of property inheritance that would have been much more difficult to achieve with the highly abstract pair of StStylable and ccss_node_t. Some operations that were previously on StStylable (like the ::style-changed signal) are directly on NtkWidget. Custom properties are no longer registered as param-specs; instead you call directly into shell theme node to look up a length or color: shell_theme_node_get_length (theme_node, "border-spacing", FALSE, &spacing); The dependency on libccss is dropped, while preserving all existing functionality and adding proper parsing and inheritance of font properties and proper inheritance for the 'color' property. Some more javascript tests for CSS functionality are added; workarounds for a CSS bug where *.some-class was needed instead of .some-class are removed. https://bugzilla.gnome.org/show_bug.cgi?id=595990
2009-09-20 01:10:15 +00:00
#include <st/st-theme.h>
#include <st/st-theme-node.h>
Import Mx core as ST Import the core MxWidget/MxBin and their dependencies; we use the namespace "St" (Shell Toolkit) because it is the same length as Mx so enabling easy sharing of code, but makes it clear that this is a friendly fork and not a literal import. Based on a patch by Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=591245
2009-09-08 19:47:30 +00:00
G_BEGIN_DECLS
[StWidget] add API support for right-to-left UI https://bugzilla.gnome.org/show_bug.cgi?id=584662
2009-11-14 17:20:31 +00:00
typedef enum {
ST_TEXT_DIRECTION_NONE,
ST_TEXT_DIRECTION_LTR,
ST_TEXT_DIRECTION_RTL
} StTextDirection;
Import Mx core as ST Import the core MxWidget/MxBin and their dependencies; we use the namespace "St" (Shell Toolkit) because it is the same length as Mx so enabling easy sharing of code, but makes it clear that this is a friendly fork and not a literal import. Based on a patch by Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=591245
2009-09-08 19:47:30 +00:00
#define ST_TYPE_WIDGET (st_widget_get_type ())
#define ST_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ST_TYPE_WIDGET, StWidget))
#define ST_IS_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ST_TYPE_WIDGET))
#define ST_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ST_TYPE_WIDGET, StWidgetClass))
#define ST_IS_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ST_TYPE_WIDGET))
#define ST_WIDGET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ST_TYPE_WIDGET, StWidgetClass))
typedef struct _StWidget StWidget;
typedef struct _StWidgetPrivate StWidgetPrivate;
typedef struct _StWidgetClass StWidgetClass;
/**
* StWidget:
*
* Base class for stylable actors. The contents of the #StWidget
* structure are private and should only be accessed through the
* public API.
*/
struct _StWidget
{
/*< private >*/
ClutterActor parent_instance;
StWidgetPrivate *priv;
};
/**
* StWidgetClass:
*
* Base class for stylable actors.
*/
struct _StWidgetClass
{
/*< private >*/
ClutterActorClass parent_class;
St: add a popup-menu signal to StWidget Add a popup-menu signal to StWidget, and emit it if the user types the Menu key or Shift+F10 while the widget is focused. https://bugzilla.gnome.org/show_bug.cgi?id=618887
2011-01-26 19:45:38 +00:00
/* signals */
void (* style_changed) (StWidget *self);
void (* popup_menu) (StWidget *self);
StWidgetAccessible: accessibility support for StWidget It includes: * Expose a proper focusable state, instead of the default one from cally, using StWidget::can_focus, and also notifying the state change * Management of the selected stated, using the current pseudo_class. * Defines a new virtual method on StWidget: get_accessible_type. In this way it is not required to reimplement get_accessible just for a accessible type change. get_accessible is reimplemented using this. You can see that as a substitute of the atk object factory https://bugzilla.gnome.org/show_bug.cgi?id=636716
2011-01-04 12:14:15 +00:00
St: add a popup-menu signal to StWidget Add a popup-menu signal to StWidget, and emit it if the user types the Menu key or Shift+F10 while the widget is focused. https://bugzilla.gnome.org/show_bug.cgi?id=618887
2011-01-26 19:45:38 +00:00
/* vfuncs */
gboolean (* navigate_focus) (StWidget *self,
ClutterActor *from,
GtkDirectionType direction);
GType (* get_accessible_type) (void);
Import Mx core as ST Import the core MxWidget/MxBin and their dependencies; we use the namespace "St" (Shell Toolkit) because it is the same length as Mx so enabling easy sharing of code, but makes it clear that this is a friendly fork and not a literal import. Based on a patch by Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=591245
2009-09-08 19:47:30 +00:00
};
GType st_widget_get_type (void) G_GNUC_CONST;
st-widget.h: fix spacing https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:45:57 +00:00
void st_widget_set_style_pseudo_class (StWidget *actor,
[StWidget] add list-like methods for style_class and pseudo_class Since style_class and pseudo_class are space-separated lists of names, add new methods to add and remove individual names rather than just re-setting the entire name. Update existing code to use the new pseudo-class methods where appropriate. In some cases, this may result in actors having multiple pseudoclasses where previously they only had one at a time, but there don't seem to be any visible differences. (There are some places that could usefully use the new style_class methods as well, but this patch doesn't change them.) Also, update test-theme.c to test the new methods. https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:37:04 +00:00
const gchar *pseudo_class_list);
void st_widget_add_style_pseudo_class (StWidget *actor,
const gchar *pseudo_class);
void st_widget_remove_style_pseudo_class (StWidget *actor,
st-widget.h: fix spacing https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:45:57 +00:00
const gchar *pseudo_class);
Remove use of G_CONST_RETURN macro. This is going to be deprecated. https://bugzilla.gnome.org/show_bug.cgi?id=644632
2011-03-13 13:29:13 +00:00
const gchar * st_widget_get_style_pseudo_class (StWidget *actor);
[StWidget] add list-like methods for style_class and pseudo_class Since style_class and pseudo_class are space-separated lists of names, add new methods to add and remove individual names rather than just re-setting the entire name. Update existing code to use the new pseudo-class methods where appropriate. In some cases, this may result in actors having multiple pseudoclasses where previously they only had one at a time, but there don't seem to be any visible differences. (There are some places that could usefully use the new style_class methods as well, but this patch doesn't change them.) Also, update test-theme.c to test the new methods. https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:37:04 +00:00
gboolean st_widget_has_style_pseudo_class (StWidget *actor,
const gchar *pseudo_class);
st-widget.h: fix spacing https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:45:57 +00:00
void st_widget_set_style_class_name (StWidget *actor,
[StWidget] add list-like methods for style_class and pseudo_class Since style_class and pseudo_class are space-separated lists of names, add new methods to add and remove individual names rather than just re-setting the entire name. Update existing code to use the new pseudo-class methods where appropriate. In some cases, this may result in actors having multiple pseudoclasses where previously they only had one at a time, but there don't seem to be any visible differences. (There are some places that could usefully use the new style_class methods as well, but this patch doesn't change them.) Also, update test-theme.c to test the new methods. https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:37:04 +00:00
const gchar *style_class_list);
void st_widget_add_style_class_name (StWidget *actor,
const gchar *style_class);
void st_widget_remove_style_class_name (StWidget *actor,
st-widget.h: fix spacing https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:45:57 +00:00
const gchar *style_class);
Remove use of G_CONST_RETURN macro. This is going to be deprecated. https://bugzilla.gnome.org/show_bug.cgi?id=644632
2011-03-13 13:29:13 +00:00
const gchar * st_widget_get_style_class_name (StWidget *actor);
[StWidget] add list-like methods for style_class and pseudo_class Since style_class and pseudo_class are space-separated lists of names, add new methods to add and remove individual names rather than just re-setting the entire name. Update existing code to use the new pseudo-class methods where appropriate. In some cases, this may result in actors having multiple pseudoclasses where previously they only had one at a time, but there don't seem to be any visible differences. (There are some places that could usefully use the new style_class methods as well, but this patch doesn't change them.) Also, update test-theme.c to test the new methods. https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:37:04 +00:00
gboolean st_widget_has_style_class_name (StWidget *actor,
const gchar *style_class);
st-widget.h: fix spacing https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:45:57 +00:00
void st_widget_set_style (StWidget *actor,
const gchar *style);
Remove use of G_CONST_RETURN macro. This is going to be deprecated. https://bugzilla.gnome.org/show_bug.cgi?id=644632
2011-03-13 13:29:13 +00:00
const gchar * st_widget_get_style (StWidget *actor);
st-widget.h: fix spacing https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:45:57 +00:00
void st_widget_set_theme (StWidget *actor,
StTheme *theme);
StTheme * st_widget_get_theme (StWidget *actor);
void st_widget_set_has_tooltip (StWidget *widget,
gboolean has_tooltip);
gboolean st_widget_get_has_tooltip (StWidget *widget);
void st_widget_set_tooltip_text (StWidget *widget,
const gchar *text);
const gchar* st_widget_get_tooltip_text (StWidget *widget);
void st_widget_show_tooltip (StWidget *widget);
void st_widget_hide_tooltip (StWidget *widget);
[StWidget] add (optional) hover tracking If track-hover is set, update the hover property automatically, and the "hover" pseudo class to match, as StClickable used to do. (Remove the corresponding code in StClickable). Tweak the tooltip handling to use track-hover, which also makes it slightly more reliable in the presence of reactive children, etc.
2010-03-19 17:47:34 +00:00
void st_widget_set_track_hover (StWidget *widget,
gboolean track_hover);
gboolean st_widget_get_track_hover (StWidget *widget);
void st_widget_set_hover (StWidget *widget,
gboolean hover);
void st_widget_sync_hover (StWidget *widget);
gboolean st_widget_get_hover (StWidget *widget);
st-widget.h: fix spacing https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:45:57 +00:00
void st_widget_ensure_style (StWidget *widget);
StTextDirection st_widget_get_default_direction (void);
void st_widget_set_default_direction (StTextDirection dir);
StTextDirection st_widget_get_direction (StWidget *self);
void st_widget_set_direction (StWidget *self,
StTextDirection dir);
Import Mx core as ST Import the core MxWidget/MxBin and their dependencies; we use the namespace "St" (Shell Toolkit) because it is the same length as Mx so enabling easy sharing of code, but makes it clear that this is a friendly fork and not a literal import. Based on a patch by Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=591245
2009-09-08 19:47:30 +00:00
St: add keyboard focus navigation support Add StWidget:can-focus, st_widget_navigate_focus(), and st_container_get_focus_chain(), and implement as needed to allow keyboard navigation of widgets. https://bugzilla.gnome.org/show_bug.cgi?id=621671
2010-06-15 16:11:39 +00:00
void st_widget_set_can_focus (StWidget *widget,
gboolean can_focus);
gboolean st_widget_get_can_focus (StWidget *widget);
gboolean st_widget_navigate_focus (StWidget *widget,
ClutterActor *from,
GtkDirectionType direction,
gboolean wrap_around);
Import Mx core as ST Import the core MxWidget/MxBin and their dependencies; we use the namespace "St" (Shell Toolkit) because it is the same length as Mx so enabling easy sharing of code, but makes it clear that this is a friendly fork and not a literal import. Based on a patch by Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=591245
2009-09-08 19:47:30 +00:00
/* Only to be used by sub-classes of StWidget */
st-widget.h: fix spacing https://bugzilla.gnome.org/show_bug.cgi?id=604943
2010-03-19 15:45:57 +00:00
void st_widget_style_changed (StWidget *widget);
StThemeNode * st_widget_get_theme_node (StWidget *widget);
Add st_widget_peek_theme_node() Sometimes it's useful to get the theme node if there is one and do nothing and wait for the ::style-changed signal if there is no theme node. Add st_widget_peek_theme_node() that just gets the current theme node if available. The caller must handle a %NULL return. https://bugzilla.gnome.org/show_bug.cgi?id=633865
2010-11-02 20:09:49 +00:00
StThemeNode * st_widget_peek_theme_node (StWidget *widget);
Port our imported parts of Mx to ShellTheme ShellTheme replaces both StStyle and ccss_stylesheet_t. The interface StStylable is replaced by usage of ShellThemeNode. A concrete node class allows some significant optimizations of property inheritance that would have been much more difficult to achieve with the highly abstract pair of StStylable and ccss_node_t. Some operations that were previously on StStylable (like the ::style-changed signal) are directly on NtkWidget. Custom properties are no longer registered as param-specs; instead you call directly into shell theme node to look up a length or color: shell_theme_node_get_length (theme_node, "border-spacing", FALSE, &spacing); The dependency on libccss is dropped, while preserving all existing functionality and adding proper parsing and inheritance of font properties and proper inheritance for the 'color' property. Some more javascript tests for CSS functionality are added; workarounds for a CSS bug where *.some-class was needed instead of .some-class are removed. https://bugzilla.gnome.org/show_bug.cgi?id=595990
2009-09-20 01:10:15 +00:00
Move Tweener.slowDownFactor into St It has probably crossed the line to evil by a mile or so, but here it is: a Tweener.slowDownFactor replacement used by all animations without exception. While at it, update Tweener to use the new setTimeScale() upstream function instead of adjusting the timeline directly. https://bugzilla.gnome.org/show_bug.cgi?id=622249
2010-06-20 02:16:06 +00:00
/* debug methods */
char *st_describe_actor (ClutterActor *actor);
void st_set_slow_down_factor (gfloat factor);
gfloat st_get_slow_down_factor (void);
Import Mx core as ST Import the core MxWidget/MxBin and their dependencies; we use the namespace "St" (Shell Toolkit) because it is the same length as Mx so enabling easy sharing of code, but makes it clear that this is a friendly fork and not a literal import. Based on a patch by Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=591245
2009-09-08 19:47:30 +00:00
Make St aware of the UI group. Inside the Shell, all the UI (including chrome, the overview, and the actual windows) is not a child of the stage but of a special ClutterGroup, which is cloned inside the magnifier. Add function for setting this special actor so that actors added by St are visible in the magnifier. Nothing yet uses this, but the tooltip will soon. https://bugzilla.gnome.org/show_bug.cgi?id=635100
2011-01-11 15:38:55 +00:00
void st_set_ui_root (ClutterStage *stage,
ClutterContainer *container);
ClutterContainer *st_get_ui_root (ClutterStage *stage);
Import Mx core as ST Import the core MxWidget/MxBin and their dependencies; we use the namespace "St" (Shell Toolkit) because it is the same length as Mx so enabling easy sharing of code, but makes it clear that this is a friendly fork and not a literal import. Based on a patch by Colin Walters <walters@verbum.org> https://bugzilla.gnome.org/show_bug.cgi?id=591245
2009-09-08 19:47:30 +00:00
G_END_DECLS
#endif /* __ST_WIDGET_H__ */
Reference in New Issue Copy Permalink