filedlg.dox 4.62 KB
Newer Older
Ercan Ersoy's avatar
Ercan Ersoy committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
/*
 FILEDLG.DOX

 License CC0 PUBLIC DOMAIN

 To the extent possible under law, Mark J. Olesen has waived all copyright
 and related or neighboring rights to FDOSTUI Library. This work is published
 from: United States.
*/


/*! \file filedlg.hpp
\brief contains file dialog class
*/

/*! \class filedlg filedlg.hpp
\brief Allows a user to choose a file 
*/

/*!
\fn filedlg::filedlg(
        int const                       i_pos_x,
        int const                       i_pos_y,
        unsigned int const              i_len_x,
        unsigned int const              i_len_y)
\brief constructor 
\param[in] i_pos_x x position to place widget
\param[in] i_pos_y y position to place widget
\param[in] i_len_x x length of widget
\param[in] i_len_y y length of widget
\returns none
*/

/*!
 \fn virtual filedlg::~filedlg()
\brief destructor
\returns none
*/

/*!
\fn unsigned char * filedlg::get_filename() const
\brief gets the filename the user choose
\returns null terminated string of file choosen

Call takes ownership of the returned string. It will need
to be released (free'd).
*/

/*!
\fn void filedlg::set_filename(
        unsigned char const*            i_filename)
\brief sets the default file name 
\returns none
*/

/*!
\var filedlg::m_label_file
	label for "File"
*/

/*!
\var filedlg::m_entry_file
	entry widget for filename
*/

/*!
\var filedlg::m_label_filter
	label for "filter"
*/

/*!
\var filedlg::m_entry_filter
	entry widget for filter
*/

/*!
\var filedlg::m_checkbutton_readonly
	readonly attribute check button
*/

/*!
\var filedlg::m_checkbutton_hidden
	hidden attribute check button
*/

/*!
\var filedlg::m_checkbutton_system
	system attribute check button
*/

/*!
\var filedlg::m_button_refresh
	system button to refresh/reload dialog
*/

/*!
\var filedlg::m_button_cancel
	cancel button
*/

/*!
\var filedlg::m_button_ok
	ok button
*/

/*!
\var filedlg::m_label_path
	label to display the path
*/

/*!
\var filedlg::m_label_message
	label to display a message such as error messages
*/

/*!
\var filedlg::m_listbox_file;
	listbox for files
*/

/*!
\var filedlg::m_combobox_directories
	combobox for directories
*/

/*!
\var filedlg::m_listbox_drives
	listbox for drives
*/

/*!
\fn void filedlg::configure_default()
\brief startup configuration. Loads the dialog up with intial
values.
\returns none
*/

/*!
\fn void filedlg::configure_listbox_file()
\brief configure file listbox. Loads files from the current directory.
\returns none
*/

/*!
\fn void filedlg::configure_listbox_directories()
\brief configure directories listbox. Loads directories from current directory.
\returns none
*/

/*!
\fn void filedlg::configure_listbox_drives()
\brief configure drives listbox. Loads drives from the hardware module.
\returns none
*/

/*!
\fn static void filedlg::listbox_drive_cb(
        listbox const*                  i_listbox,
        void*                           io_user_data)
\brief listbox drives callback
\param[in] i_listbox listbox widget
\param[in] io_user_data user defined data
\returns none
*/

/*! 
\fn static void filedlg::combobox_directory_cb(
        entry const*                    i_entry,
        void*                           io_user_data)
\brief combobox directories callback
\param[in] i_entry entry widget
\param[in] io_user_data user defined data
\returns none
*/

/*!
\fn static void filedlg::listbox_file_cb(
        listbox const*                  i_listbox,
        void*                           io_user_data)
\brief listbox file callback
\param[in] i_listbox listbox widget
\param[in] io_user_data user defined data
\returns none
*/

/*!
\fn static void filedlg::checkbutton_attribute_cb(
        button const*                   i_button,
        void*                           io_user_data)
\brief attributes call back (system, readonly, hidden)
\param[in] i_button button widget
\param[in] io_user_data user defined data
\returns none

/*!
\fn static void filedlg::button_refresh_cb(
        button const*                   i_button,
        void*                           io_user_data)
\brief refresh button callback
\param[in] i_button button widget
\param[in] io_user_data user defined data
\returns none
*/

/*!
\fn void filedlg::drive_changed_internal()
\brief event handler when drive changes
\returns none
*/

/*!
\fn void filedlg::directory_changed_internal()
\brief event handler when directory changed
\returns none
*/

/*!
\fn void filedlg::file_changed_internal()
\brief event handler when file changed
\returns none
*/

/*!
\fn void filedlg::attribute_changed_internal()
\brief event handler when attribute (hidden, system, readonly) changed
\returns none
*/

/*!
\fn void filedlg::refresh()
\brief refreshes/reloads dialog box
\returns none
*/