RtcomPage

RtcomPage

Synopsis




            RtcomPage;
void        rtcom_page_set_account          (RtcomPage *page,
                                             RtcomAccountItem *account);
gboolean    rtcom_page_validate             (RtcomPage *page,
                                             GError **error);
const gchar* rtcom_page_get_title           (RtcomPage *page);
void        rtcom_page_set_object_can_next  (RtcomPage *page,
                                             GObject *object,
                                             gboolean can_next);

Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----RtcomPage

Implemented Interfaces

RtcomPage implements AtkImplementorIface and GtkBuildable.

Properties


  "can-next"             gboolean              : Read
  "last"                 gboolean              : Read / Write
  "title"                gchararray            : Read / Write
  "valid"                gboolean              : Read

Signals


"set-account"
            void        user_function      (RtcomPage        *page,
                                            RtcomAccountItem *account,
                                            gpointer          user_data)      : Run last / Action
"validate"  gboolean    user_function      (RtcomPage *page,
                                            gpointer   error,
                                            gpointer   user_data)      : Run last / Action

Description

Details

RtcomPage

typedef struct _RtcomPage RtcomPage;


rtcom_page_set_account ()

void        rtcom_page_set_account          (RtcomPage *page,
                                             RtcomAccountItem *account);

Associate page with account. This function binds all child widgets to that account, and must be called only after all the widgets have been added to the page.

page : the RtcomPage
account : the RtcomAccountItem

rtcom_page_validate ()

gboolean    rtcom_page_validate             (RtcomPage *page,
                                             GError **error);

Call this function to valdiate the page.

page : the RtcomPage.
error : a pointer to a GError variable.
Returns : TRUE if validation is successful, FALSE otherwise.

rtcom_page_get_title ()

const gchar* rtcom_page_get_title           (RtcomPage *page);

Gets the title of this page.

page : the RtcomPage.
Returns : a constant string.

rtcom_page_set_object_can_next ()

void        rtcom_page_set_object_can_next  (RtcomPage *page,
                                             GObject *object,
                                             gboolean can_next);

This method adds object to the list of the items to be taken into consideration by page in enabling/disabling its "can-next" property. The RtcomPage already monitors the RtcomWidget objects for the "can-next" property, so this method must be used only for those objects that are either non-RtcomWidget or that are not children of page, but that can anyway have an effect on the page "can-next" flag. Note also that object is only being used as a key for indexing the can_next flag: it doesn't need to expose a "can-next" property, because anyway the RtcomPage won't monitor or even look at it; changes to object's "can-next" state must be advertised calling this function whenever they change. The reference count of object is not touched; the caller is responsible to make sure that object doesn't die while the page is using it.

page : the RtcomPage.
object : a GObject.
can_next : a gboolean that specifies the "can-next" flag for object.

Property Details

The "can-next" property

  "can-next"             gboolean              : Read

Allow page `Next' button.

Default value: FALSE


The "last" property

  "last"                 gboolean              : Read / Write

Last page in the wizard.

Default value: FALSE


The "title" property

  "title"                gchararray            : Read / Write

Title of the page.

Default value: NULL


The "valid" property

  "valid"                gboolean              : Read

Valid.

Default value: FALSE

Signal Details

The "set-account" signal

void        user_function                  (RtcomPage        *page,
                                            RtcomAccountItem *account,
                                            gpointer          user_data)      : Run last / Action

Emitted to associate the RtcomPage with account.

page : The RtcomPage.
account : The RtcomAccountItem to set.
user_data : user data set when the signal handler was connected.

The "validate" signal

gboolean    user_function                  (RtcomPage *page,
                                            gpointer   error,
                                            gpointer   user_data)      : Run last / Action

Emitted to start page validation. If some error occurs, the handler should return FALSE and store an error in the error parameter.

page : The RtcomPage.
error : Variable to receive an error.
user_data : user data set when the signal handler was connected.
Returns : TRUE for success, of FALSE.