Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Public Member Functions
Xfc::Gtk::RcStyle Class Reference

A GtkRcStyle C++ wrapper class. More...

#include <xfc/gtk/rc.hh>

Inheritance diagram for Xfc::Gtk::RcStyle:
Xfc::G::Object Xfc::G::TypeInstance Xfc::Trackable

List of all members.

Public Member Functions

Constructors


Detailed Description

A GtkRcStyle C++ wrapper class.

The RcStyle structure is used to represent a set of information about the appearance of a widget. This can later be composited together with other RcStyle structures to form a Style.

Note: dynamically allocated objects must either be unreferenced or assigned to a smart pointer. Stack objects are automatically unreferenced when they go out of scope.


Constructor & Destructor Documentation

Xfc::Gtk::RcStyle::RcStyle ( GtkRcStyle *  rc_style,
bool  owns_reference = true 
) [explicit, protected]

Construct a new RcStyle from an existing GtkRcStyle.

Parameters:
rc_styleA pointer to a GtkRcStyle.
owns_referenceSet false if the initial reference count is floating, set true if it's not.

The rc_style can be a newly created GtkRcStyle or an existing GtkRcStyle (see G::Object::Object).

Xfc::Gtk::RcStyle::RcStyle ( )

Constructs a new RcStyle with no fields set and a reference count of 1 that the caller owns.


Member Function Documentation

Gets the base color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
Returns:
The Gdk::Color for state_type.
bool Xfc::Gtk::RcStyle::base_set ( StateType  state) const

Determines whether the base color for state_type is set.

Returns:
true if the base color is set.

Gets the background color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
Returns:
The Gdk::Color for state_type.

Gets the name of the pixmap used as the background for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
Returns:
The name of the background pixmap, or a null string if a pixmap name has not been set.
bool Xfc::Gtk::RcStyle::bg_set ( StateType  state) const

Determines whether the background color for state_type is set.

Returns:
true if the background color is set.

Makes a copy of the specified RcStyle.

This method will correctly copy an RC style that is a member of a class derived from RcStyle.

Gets the foreground color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
Returns:
The Gdk::Color for state_type.
bool Xfc::Gtk::RcStyle::fg_set ( StateType  state) const

Determines whether the foreground color for state_type is set.

Returns:
true if the foreground color is set.

Gets the font description for the RC style.

Returns:
A Pango::FontDescription.

Gets the name of the RC style.

Returns:
The name of the RC style, or a null string if a name has not been set.
void Xfc::Gtk::RcStyle::set_base ( StateType  state_type,
const Gdk::Color color 
)

Sets the base color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
colorThe Gdk::Color for state_type.
void Xfc::Gtk::RcStyle::set_bg ( StateType  state_type,
const Gdk::Color color 
)

Sets the background color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
colorThe Gdk::Color for state_type.
void Xfc::Gtk::RcStyle::set_bg_pixmap_name ( StateType  state_type,
const String name 
)

Sets the name of the pixmap to use as the background for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
nameThe new pixmap name, or null to unset the current pixmap name.
void Xfc::Gtk::RcStyle::set_fg ( StateType  state_type,
const Gdk::Color color 
)

Sets the foreground color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
colorThe Gdk::Color for state_type.

Sets the font description for the RC style.

Parameters:
font_descThe new font description, or null to unset the current font description.
void Xfc::Gtk::RcStyle::set_name ( const String name)

Sets the name of the RC style.

Parameters:
nameThe new name for the RC style, or null to unset the current name.
void Xfc::Gtk::RcStyle::set_text ( StateType  state_type,
const Gdk::Color color 
)

Sets the text color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
colorThe Gdk::Color for state_type.

Sets the current value used for various horizontal padding values in GTK+, such as frame and bevel size.

Parameters:
sizeThe new horizontal padding value.

Sets the current value used for various vertical padding values in GTK+, such as frame and bevel size.

Parameters:
sizeThe new vertical padding value.

Gets the text color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
Returns:
The Gdk::Color for state_type.
bool Xfc::Gtk::RcStyle::text_set ( StateType  state) const

Determines whether the text color for state_type is set.

Returns:
true if the text color is set.

Unsets the base color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
void Xfc::Gtk::RcStyle::unset_bg ( StateType  state_type)

Unsets the background color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.
void Xfc::Gtk::RcStyle::unset_fg ( StateType  state_type)

Unsets the foreground color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.

Unsets the text color for state_type.

Parameters:
state_typeOne of the values in the Gtk::StateType enumeration.

Obtains the current value used for various horizontal padding values in GTK+, such as frame and bevel size.

Returns:
The current horizontal padding value.

Obtains the current value used for various vertical padding values in GTK+, such as frame and bevel size.

Returns:
The current vertical padding value.

The documentation for this class was generated from the following file:
Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC