![]() |
![]() |
![]() |
plank Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Signals |
#define PLANK_FACTORIES_TYPE_ABSTRACT_MAIN gint plank_factories_abstract_main_run (PlankFactoriesAbstractMain *self
,gchar ***args
,int *args_length1
); void plank_factories_abstract_main_initialize_program (PlankFactoriesAbstractMain *self
); gboolean plank_factories_abstract_main_parse_commandline (PlankFactoriesAbstractMain *self
,gchar ***args
,int *args_length1
); void plank_factories_abstract_main_set_options (PlankFactoriesAbstractMain *self
); gboolean plank_factories_abstract_main_initialize_libraries (PlankFactoriesAbstractMain *self
,gchar ***args
,int *args_length1
); void plank_factories_abstract_main_initialize_services (PlankFactoriesAbstractMain *self
); void plank_factories_abstract_main_create_controller (PlankFactoriesAbstractMain *self
); gboolean plank_factories_abstract_main_is_launcher_for_dock (PlankFactoriesAbstractMain *self
,const gchar *launcher
); void plank_factories_abstract_main_help (PlankFactoriesAbstractMain *self
); void plank_factories_abstract_main_translate (PlankFactoriesAbstractMain *self
); void plank_factories_abstract_main_quit (PlankFactoriesAbstractMain *self
); void plank_factories_abstract_main_on_item_clicked (PlankFactoriesAbstractMain *self
); void plank_factories_abstract_main_show_about (PlankFactoriesAbstractMain *self
); struct PlankFactoriesAbstractMain; struct PlankFactoriesAbstractMainClass;
#define PLANK_FACTORIES_TYPE_ABSTRACT_MAIN (plank_factories_abstract_main_get_type ())
The type for PlankFactoriesAbstractMain.
gint plank_factories_abstract_main_run (PlankFactoriesAbstractMain *self
,gchar ***args
,int *args_length1
);
Initializes the program, makes the dock and runs it.
|
the PlankFactoriesAbstractMain instance |
|
. the command-line arguments. [inout][array length=args_length1] |
|
length of the args array |
Returns : |
the exit status value |
void plank_factories_abstract_main_initialize_program
(PlankFactoriesAbstractMain *self
);
Sets the program executable's name, traps signals and intializes logging.
|
the PlankFactoriesAbstractMain instance |
gboolean plank_factories_abstract_main_parse_commandline (PlankFactoriesAbstractMain *self
,gchar ***args
,int *args_length1
);
Parses the command-line for options, but does not set them.
|
the PlankFactoriesAbstractMain instance |
|
. the command-line arguments. [inout][array length=args_length1] |
|
length of the args array |
Returns : |
whether the arguments were parsed successfully |
void plank_factories_abstract_main_set_options
(PlankFactoriesAbstractMain *self
);
Sets options based on the parsed command-line.
|
the PlankFactoriesAbstractMain instance |
gboolean plank_factories_abstract_main_initialize_libraries (PlankFactoriesAbstractMain *self
,gchar ***args
,int *args_length1
);
Initializes most libraries used (GTK, GDK, etc).
|
the PlankFactoriesAbstractMain instance |
|
. the command-line arguments. [inout][array length=args_length1] |
|
length of the args array |
Returns : |
whether the libraries were intialized successfully |
void plank_factories_abstract_main_initialize_services
(PlankFactoriesAbstractMain *self
);
Initializes the Plank services.
|
the PlankFactoriesAbstractMain instance |
void plank_factories_abstract_main_create_controller
(PlankFactoriesAbstractMain *self
);
Creates the dock controller.
|
the PlankFactoriesAbstractMain instance |
gboolean plank_factories_abstract_main_is_launcher_for_dock (PlankFactoriesAbstractMain *self
,const gchar *launcher
);
Is true if the launcher given is the launcher for this dock.
|
the PlankFactoriesAbstractMain instance |
|
. the launcher to test. [in] |
void plank_factories_abstract_main_help (PlankFactoriesAbstractMain *self
);
Displays the help page.
|
the PlankFactoriesAbstractMain instance |
void plank_factories_abstract_main_translate
(PlankFactoriesAbstractMain *self
);
Displays the translate page.
|
the PlankFactoriesAbstractMain instance |
void plank_factories_abstract_main_quit (PlankFactoriesAbstractMain *self
);
Quits the program.
|
the PlankFactoriesAbstractMain instance |
void plank_factories_abstract_main_on_item_clicked
(PlankFactoriesAbstractMain *self
);
Called when a PlankItemsPlankDockItem is clicked.
|
the PlankFactoriesAbstractMain instance |
void plank_factories_abstract_main_show_about
(PlankFactoriesAbstractMain *self
);
Displays the about dialog.
|
the PlankFactoriesAbstractMain instance |
struct PlankFactoriesAbstractMain;
The main class for all dock applications. All docks should extend this class. In the constructor, the string fields should be initialized to customize the dock.
struct PlankFactoriesAbstractMainClass { GObjectClass parent_class; gint (*run) (PlankFactoriesAbstractMain* self, gchar*** args, int* args_length1); void (*initialize_program) (PlankFactoriesAbstractMain* self); gboolean (*parse_commandline) (PlankFactoriesAbstractMain* self, gchar*** args, int* args_length1); void (*set_options) (PlankFactoriesAbstractMain* self); gboolean (*initialize_libraries) (PlankFactoriesAbstractMain* self, gchar*** args, int* args_length1); void (*initialize_services) (PlankFactoriesAbstractMain* self); void (*create_controller) (PlankFactoriesAbstractMain* self); void (*help) (PlankFactoriesAbstractMain* self); void (*translate) (PlankFactoriesAbstractMain* self); void (*quit) (PlankFactoriesAbstractMain* self); void (*on_item_clicked) (PlankFactoriesAbstractMain* self); void (*show_about) (PlankFactoriesAbstractMain* self); };
The class structure for PLANK_FACTORIES_TYPE_ABSTRACT_MAIN
. All the fields in this structure are private and should never be accessed directly.
GObjectClass |
the parent class structure |
virtual method called by plank_factories_abstract_main_run()
|
|
virtual method used internally | |
virtual method used internally | |
virtual method used internally | |
virtual method used internally | |
virtual method used internally | |
virtual method used internally | |
virtual method called by plank_factories_abstract_main_help()
|
|
virtual method called by plank_factories_abstract_main_translate()
|
|
virtual method called by plank_factories_abstract_main_quit()
|
|
virtual method called by plank_factories_abstract_main_on_item_clicked()
|
|
virtual method called by plank_factories_abstract_main_show_about()
|
"initialized"
signalvoid user_function (PlankFactoriesAbstractMain *abstract_main,
gpointer user_data) : Run Last
Signal fired when the program is fully initialized, before creating and showing the dock.
|
the PlankFactoriesAbstractMain instance that received the signal |
|
user data set when the signal handler was connected. |